【问题标题】:What is the point of redundant php docblock tags like @static?像@static这样的冗余php docblock标签有什么意义?
【发布时间】:2012-09-02 18:38:42
【问题描述】:

在 PhpStorm 中使用自动 php docblock 生成时,我最终在静态方法上使用了 @static 注释:

/**
 * Reset the singleton instance, for the tests only
 * @static
 */
public static function reset() {
    self::$singletonInstance = null;
}

如果可以从代码中推断出这些标签,它们有什么用处吗?我正在尝试决定是否应该保留或删除它(并且在任何地方都这样做,以保持一致)。

【问题讨论】:

    标签: php phpdoc phpstorm docblocks


    【解决方案1】:

    这些标签是为不允许在代码中使用此类关键字的旧 PHP 4 代码引入的。在 PHP 5 中,代码有效地自我记录,所以这些标签确实是多余的;我认为没有任何理由保留它们。

    事实上,如果您曾经为您的 PHP 5 源文件生成文档,phpDocumentor 应该仍然能够确定这些是静态方法。 phpDocumentor docs中提到了这一点:

    只需在代码中使用 static 关键字就足以让 PHP5 上的 PhpDocumentor 识别静态变量和方法,并且 PhpDocumentor 会将它们标记为静态。

    【讨论】:

    • 哦,是的,我没想到 PHP4,现在说得通了 ;)
    猜你喜欢
    • 2012-10-27
    • 2012-02-22
    • 2010-11-28
    • 2016-10-23
    • 1970-01-01
    • 1970-01-01
    • 2018-10-29
    • 1970-01-01
    • 2011-04-01
    相关资源
    最近更新 更多