php - PHP 函数声明上方的奇怪注释

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