Question

我注意到很多脚本都有这些类型的注释：

/**
 * Retrieve list of themes with theme data in theme directory.
 *
 * The theme is broken, if it doesn't have a parent theme and is missing either
 * style.css and, or index.php. If the theme has a parent theme then it is
 * broken, if it is missing style.css; index.php is optional. The broken theme
 * list is saved in the {@link $wp_broken_themes} global, which is displayed on
 * the theme list in the administration panels.
 *
 * @since 1.5.0
 * @global array $wp_broken_themes Stores the broken themes.
 * @global array $wp_themes Stores the working themes.
 *
 * @return array Theme list with theme data.
 */
function get_themes() {
    global $wp_themes, $wp_broken_themes;

    ...

    return $wp_themes;
}

它看起来像函数的某种文档，但是@前面的单词是什么？

喜欢@since，@ global，@ return，@ access，@ param等......？

我知道他们的意思，但为什么他们面前有@？他们需要识别某种文档应用吗？

Answer 1

这是JavaDoc标准。作者很可能选择它，因为大多数IDE会自动格式化它。

http://en.wikipedia.org/wiki/Javadoc

Answer 2

他们是否需要识别某种文档应用程序？

它们对于phpDocumentor等自动记录器非常有用，并且通常是记录代码的好方法。作为wasabi has pointed out，IDE也可以接受它们并为您做一些有用的事情，比如函数参数类型建议。

即使你没有记录你的代码，这也是一个很好的习惯 - 只是不要觉得有必要去做一些人的事情（记录所有可能的东西）。

Answer 3

它是PHPDoc，这是对心爱的Javadoc格式的改编。

这些文档格式由于其强制一致性而更具可读性，并且对于phpdoc等IDE和自动文档生成器非常有用。

Answer 4

对于PHP来说，phpDocumentor或多或少是JavaDoc。

Answer 5

这绝对是PHP Documentator。 “@something”部分用于向文档添加信息。有关详细信息，请参阅PHP Documentator's documentation - 它甚至还有以PHP Documentator格式从注释（here）生成文档文件的工具。

希望对你有所帮助。

PHP函数声明上面的奇怪评论

5 个答案: