2007年10月12日

コメントは大量に

コメントドリブン開発 - コメントを書いてからコードを書くことの効能 (マイコミジャーナル)

自分が書くPHPのコード、コメントは多い方だな。
コメントドリブンというようなコメント先行型とはちょっと違うけど、
後のデバッグ処理のために結構こまめにコメントを入れる方。
ある一定の処理ごとにコメントを付けてグループ化しておけば、
不具合がない部分は丸ごと読み飛ばすことが出来るので…

真っ白な状態からコーディングする時にはまず、
classやfunction名、その中のループ文だけを並べ、
それぞれどういう処理をするのかってことをコメントで併記する。
未完成の部分はprint文を入れたりハードコーディングしたりして
とりあえずどこまで処理が出来てるのかを把握できるようにし、
徐々に細かい部分を作っていく、というタイプだな。

最近は表示部分をテンプレートとして分離することが多いし、
開く時に文字コードが合わなかったりすると面倒くさいので、
入れるコメントはもっぱら「いい加減な」英語を使ってる。
とりあえず理解できる程度には簡潔で分かりやすいように…

0 コメント:

コメントを投稿