PHPコメント形式：自動生成またはユーザー作成？

Question

私はいつもこれらのヘッダーコメントをphpで見てきましたが、しばしばそれらを設定するためにいくつかのソフトウェアが使用されているのかと疑問に思っていましたか？私はJavaDocか何かを思い出すようですか？しかし、これが自動生成されているかどうかはわかりません。それとも、これは単なるドキュメントスタンダードですか？

次の例では、CodeIgniterからです：

/** 
* CodeIgniter 
* 
* An open source application development framework for PHP 4.3.2 or newer 
* 
* @package  CodeIgniter 
* @author  ExpressionEngine Dev Team 
* @copyright Copyright (c) 2008, EllisLab, Inc. 
* @license  http://codeigniter.com/user_guide/license.html 
* @link  http://codeigniter.com 
* @since  Version 1.0 
* @filesource 
*/ 

私は本当に私のコメントを改善したいと私は、これは私のプロジェクトのための偉大な形になる感じ。

Answer 1

phpDocこれは、コードを使用してクラスを動的に理解して使用するためにリフレクションを使用する一部のフレームワークで使用されます。

のIDEはまたあなたのIDEは、あなたがあなたが書いたコードを使用してではなく、フレームワークのために、これらの機能を提供しているかどうかを知るためになど、良いことを関数の引数を示し、オートコンプリートのためにそれを使用します。

PHP's Reflection API

Zend Framework Extension (including DocBlocks)

CodeIgniter's Comment Guide (Using DocBlock '...so they can be picked up by IDEs')

DocBlock Description on phpdoc.org (linked from CI's Style Guide)

Answer 2

これはJavaDocであり、おそらくIDEによって自動生成されています。

Answer 3

いくつかのIDEのあなたは、それがPHP DocumentorだPHPの場合は、自動的にそれを置くが、人々はしばしばちょうどに入力します。

することができますquickstart guide hereが表示されます。

これはあなたのソースコードをスキャンして、あなたのファイル、クラスや関数のあなたのコメントに基づいてドキュメントを作成します。

Answer 4

これらのコメントは標準phpdocに準拠しており、コードのドキュメントを自動的に生成するために使用できます。そのような文書の例を見ることができますhere。

いくつかのIDEが簡単にそれらを書くようにするサポートを持っているが、実際の内容は、プログラマが手書きされます。