概要
クラスや関数などの直前に記述し、その説明を記載するための
特定のルールに則ったコメントのこと。
phpDocumentatorと呼ばれるツールを利用することで、
自動的に必要な情報を取り出し、仕様書として整形できる。
ドキュメンテーションコメントで利用できる主なタグ
| 基本 | @author | 作者 |
| @copyright | 著作権 | |
| @license | 適用されるライセンス | |
| @version | バージョン情報 | |
| メソッド | @param | 引数 |
| @return | 戻り値 | |
| @throws | 例外 | |
| マジックメソッド | @method | __call / __callStatic で呼び出されるメソッド |
| @property | __get / __set経由で呼び出されるプロパティ | |
| その他 | deprecated | 非推奨 |
| @see | 参照 |
使用方法
Windowsの場合（XAMPP）
> php.exe phpDocumentor.phar -d PHPファイルが格納されるフォルダ -t 作成したファイルを保存する場所