@return 标签对返回类型声明没用吗答案

【问题标题】：Is @return tag useless with return type declaration@return 标签对返回类型声明没用吗
【发布时间】：2016-09-25 13:55:30
【问题描述】：

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

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

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

【问题讨论】：

【解决方案1】：

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

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

【讨论】：

【解决方案2】：

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

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

其他应用，设置多个返回值的描述信息：

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

【讨论】：

【解决方案3】：

如果它返回一个 int 或 boolean，您的文档应该说它返回一个 int 或 boolean。

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

【讨论】：