phpDocumentorのクラス:フォーマット

2016.12.21 (水)

PHPのコントローラの頭とかにあるコメントはこんな感じで書いておくとphpDocumentorがいい感じに読み込んでくれる。

/**
 * [区分]クラスの概要
 *
 * クラスの詳細
 * 出来るだけ細かく書いたほうがよいが、詳細な説明は各メソッドに任せる。
 * 全体での共通ルールとか仕様を書く。
 *
 * @access アクセスレベル
 * @author 名前 <メールアドレス>
 * @copyright 会社名 All Rights Reserved
 * @category カテゴリー(処理系)
 * @package パッケージ(MVC)
 */