@return 标签对 return 类型声明没用吗

Question

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

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

我们是否应该在 PHP7 中删除此注释？

Answer 1

如果它 returns 是一个整数或布尔值，您的文档应该说它是 returns 一个整数或布尔值。

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

Answer 2

如果 class 名称 用作 @return 标记中的数据类型而不是 'int'， phpdoc 会自动为 class 的文档创建一个 link。

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

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

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

Answer 3

Should we remove this annotation in PHP7?

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

Is @return tag useless with return type declaration