2012-03-29 13 views
9

PHPでは、人々は「@」記号をソースコードのコメントに入れていることに気付きました。一つのすばらしい例はWordPressです。あなたがソースを見てみると、あなたはコメントの "@"記号は何ですか?

/** Results of the last query made 
* 
* @since 1.0.0 
* @access private 
* @var array|null 
*/ 
var $last_result 

のようなもの(WP-をdb.php、ライン124)

を参照してくださいそれは私がそれが何かをすると仮定しているので、私のエディタでシンタックスハイライトを変更しますが、私はそれが何をするか分からない。誰かがコメントで "@"記号が何をしているのか説明しますか?

答えて

7

これはPHPDocコメントです。自動化されたドキュメントとIDEコードの完成をサポートするために、機械で解析できるようになっています。

0

このような表記は、コメントからドキュメントパーサーを作成する方法として機能します。したがって、最初の@はバージョン、2番目は引数として識別できます。

0

これは、通常、ソースコードファイルからドキュメントを自動生成するために行われます。この場合、@_は、変数に関するメタデータを識別するために使用されます。 @varは順序で評価される代わりに、次のテキストが変数などを記述していることをドキュメントパーサーに伝えることができます。

3

これまでの回答は、ソースコメントの@記号がPHPDocコメントであることを示しています。また、コードの一部の要素にメタデータを追加し、アプリケーションの動作に影響を与える可能性のある「注釈」と呼ばれるものにも使用できます。 PHPで正式にサポートされているわけではありませんが、数年前から議論中であり、Symfony、Doctrineなどのプロジェクトで使用されています。

すべての物事のPHPのスライドショー(私となし所属)と注釈を経由して優れた解説:

http://www.slideshare.net/rdohms/annotations-in-php-they-exist

注釈の対象の一般的な議論:

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

アンPHPのアノテーションの実装に関する2010年のRFC:

http://wiki.php.net/rfc/annotations

関連する問題