PHPのドキュメンテーションコメントについて

概要

クラスや関数などの直前に記述し、その説明を記載するための
特定のルールに則ったコメントのこと。
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 作成したファイルを保存する場所

コメント

タイトルとURLをコピーしました