@return标记对返回类型声明无用吗?

Question

phpdoc 的 @return 标签对返回类型声明毫无用处吗？换句话说，在这种情况下@return标签有什么好处：

/**
 * Example function.
 *
 * @return int
 */
public function getOne(): int
{
    return 1;
}

我们应该在 PHP7 中删除这个注释吗？

Answer 1

我们应该在 PHP7 中删除这个注释吗？

虽然@return乍一看可能看起来是多余的，但事实并非如此。它允许您对返回值及其含义进行更详细的描述，而不仅仅是值的类型，在返回更复杂的数据（即数组）的情况下可能毫无用处，因此我宁愿付出更多的努力来使我的文档更好通过使用此功能而不是删除没有真正好处的@return。

Answer 2

如果在 @return 标签中使用类名而不是 'int' 作为数据类型，phpdoc 将自动创建指向该类文档的链接。

/**
 * Example function.
 *
 * @return className
 */

其他应用程序，用于设置有关多个返回值的描述性信息：

/**
 * Example function.
 *
 * @return int|string could be an int, could be a string 
 */

Answer 3

如果它返回一个 int 或一个布尔值，你的文档应该说它返回一个 int 或布尔值。

/**
  * @return int 1 on success, 0 means failure
 */