奇妙なコメント

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

phpDocumentorのようになります。多かれ少なかれ、PHPではJavaDocです。

Answer 4

PHPDocこれは、最愛のJavadoc形式を採用したものです。

これらのドキュメントフォーマットは、強制的な一貫性により若干読みやすく、IDEや自動ドキュメントジェネレータ（phpdocなど）に便利です。

Answer 5

これは間違いなくPHP Documentatorです。 "@ something"部分は、ドキュメントに情報を追加するために使用されます。詳細はPHP Documentator's documentationを参照してください。PHP Documentatorの形式でコメント（here）からドキュメンテーションファイルを生成するツールもあります。

希望はあなたを助けます。