前回に引き続き、コメントの付け方を分析してみた。

自分の考えを記録する

リーダブルコードにコメントの付け方について以下の記述がある。

映画のDVDにはよく「監督のコメンタリー」がついてくる。映画の製作者が自分の考えや物語について語ってくれるので、作品がどのように作られたのかを理解するのに役立つ。これと同じように、コメントにはコードに対する大切な考えを記録しなければいけない。
引用元：Dustin Boswell, Trevor Foucher『リーダブルコード』オライリー・ジャパン出版

確かに映画のコメンタリーを見ると作品の成り立ちや見所がわかる。この後どういう展開につながるか、のような後の展開につながる内容もある。コードで例えると「ここでこういうデータを取得してこう編集して最後にここへ登録する」みたいな感じで流れを書くといいのかな？定数に設定した値の根拠を書くのも良いみたいだ。

今まで、コメントはクラス・メソッドなど大きな単位ではなく1ブロック・1行の小さな単位にしか付けてこなかった気がする。自然と視野が狭くなっていたんだな。。。

＜大きな発見＞
自分が書いていないコードでバグが出た時「なんで気づけなかったんだろう」と思う。その要因はここにあるのかもしれない。大きな単位でコメントを付けていない＝全体を見れていない、ってことじゃないか？よし、大きな単位でコメントが必要か見る癖を付けよう！（多分「当たり前やろ」ってツッコまれる…）