2012 ねん 6 がつ 28 にち
15:00 おき。かなり疲労がたまっている。
以前休日出勤した振替が消滅しそうになるので、休む。
コードにコメントを書くべきかどうかという議論があるけど、コメントは書くべきだと思っている。コメントなどなくとも、分かるコードを書くべきってのはある。もちろん、読めば分かる当たり前の情報など書くべきではないと思っている。例えば、この変数を1に初期化とかそういうのはいらない。コメントに書くべきは、そうではなくて、コードにはコードからは読み取りづらい付加情報や背景を書くべきと考えている。例えば、以下のような情報。
- 現在の設計を採用した理由。コードに使用されているアルゴリズムとか。○○を使用していて、何故これを選択したか。他のアルゴリズム A よりも、メモリ効率が良いから選択したのような。
- コードの背景にある仕様や制限。××のような仕様や制限があるから、このようなコードとなっているのような。
とかとか考えていた。できる限りコードだけ見れば全部分かるようにするべきというか、なんというか。まあ、あとは、どうせコメント書くなら、ドキュメント化を意識して書きたいよねとか。Doxygen に通るようにするとかそういう。ぱっと思いついて書いただけの文章。
