コメント内の「@」はなぜですか？

Question

時々、私はいくつかの行の前に '@'が付いたPHPコメントを見ます。 @Authorのように。これには特別な理由はありますか？私はこれについて何かを見つけることができないようです。私は '@'を探す高度に使われたパーサがあると仮定しています。

Answer 1

これはphpDocumentor表記、ソースコードを解析し、プログラム（およびそれら@コメント）自動生成ドキュメントへの最も可能性が高いです。多くのIDEは、これらのコメントに基づいてインテリジェントなルックアップとオートコンプリート機能も提供します。

例：

/** 
* Echoes "example". 
* @author Pekka 
* @version 1.5 
* @return void 
*/ 
function example() 
    { 
    echo "example"; 
    } 

Answer 2

これはコメントからドキュメントを作成するために、自動ドキュメンテーションジェネレータによって使用されています。いくつかのツールやフォーマットはそこにあります。

• phpDocumentorの
• Doxygenの
• HeaderDoc

は数を一覧表示します。

Answer 3

コメントのソースコードを解析し、（など、HTML、Windowsのの.chmファイル、など）さまざまな形式で複雑なヘルプファイルを作成したパッケージがたくさんあります。 Javaにはjavadocがありますが、DoxygenとDoc-O-Maticもあります。