phpDocumentorの書き方 - Qiita

phpDocumentorの書き方ってこれ！っていうベストプラクティスがなくて（ドキュメントとはそういうものなのかもしれないけど…）、毎回試行錯誤して、フォーマットを考えるだけでも時間を取られるので、一度自分なりのフォーマットをまとめたいと思います。 今回は、クラスとメソッドについてまとめています。 プロパティについても書いたほうがドキュメントとしてはよいと思うのですが、プロパティまで書き出すとなかなか継続出来ない（ダメ人間です）ので、追々。。 ちなみに、CakePHPをやんわり想定しています。 では、まずクラスについて。 クラス：フォーマット /** * [区分]クラスの概要 * * クラスの詳細 * 出来るだけ細かく書いたほうがよいが、詳細な説明は各メソッドに任せる。 * 全体での共通ルールとか仕様を書く。 * * @access アクセスレベル * @author 名前 <メールアド