2005-11-06 コード中のコメント作法 development コード中にコメントを書く 当たり前のこと 前にいた会社の新人研修でCOBOLを勉強したとき、執拗に書けといわれた 今でもきちんと書くほうだと思う、仕事ではJavadocもかなり書く そういえば自分用のライブラリでもJavadocすごく書いてた 最近、過剰なコメントは不要だと思う コメントがなくても理解できるほうがいい! ロジック/アルゴリズムの標準化、単純化 機能を連想させるような命名(変数名、関数名、クラス名など) 今後の方針 最低限のコメントは書くよ Javadocコメント phpDocumentatorで出力可能なコメント ビジネスロジックに依拠しないコメントは減らそう ライブラリ/ユーティリティ化できる可能性があることを示しているかも フレームワークで解決できる部分はそちら側で # もちろん、意味不明なコードなのにコメントがないのは論外。