Pixel Pedals of Tomakomai

北海道苫小牧市出身の初老の日常

コメントが嫌い

開発において重要視されるソースへのコメント。もちろん、仕事ではきちんと書いているが、個人的にはソースにごちゃごちゃとコメントをつけるのはよくないと思う。



開発の現場を見ていると、ソースが更新されても、コメントは更新されていないと言うパターンがあまりにも多過ぎる。この傾向は、何人もの先人が口を酸っぱくして同じことを言っているのにもかかわらず、未だに直っていない。つまり、コメントを書くよう強制する行為自体がすでに目的を達成できておらずナンセンスであり、別の方法を用意すべきであると思うのだ。



ソースからコメントが減れば、この問題は一気に解決する。直すべきコメントがないのだから。本来、メソッド名や引数を英単語で適切につけていれば、それを改めて日本語で説明する必要はないはずなんだよ。



コメントが"死んでいるデータ"だと言う事実も、忘れてはならない。コメントはプログラム実行時には完全に無視されてしまうため、一度人間の手を離れるとその妥当性を問われる機会はなくなってしまう。それに対してソースの部分は、プログラムの実行によって何百回〜何万回も精査されている、生きのいいデータだ。腐りやすいコメント部分を腐らせないように保つには、大変な労力が必要となる。



とは言っても、コメントは全部NGと言うわけではなく、必要なものも当然存在する。その代表例は、定石をはずしたコーディングをしているときにつけるコメント。これに関しては、コメントしておかなければ後の人が定石な手法に直してしまう恐れがあるので、なぜ定石をはずしたのかを明確にしておくことは重要だ。ただし、このレベルのコメントであればソースを修正した時に自然と消されて書き直される場合がほとんどである。



で、もう一つコメントの代わりに重要だと思うのが単体テストのプログラム。シンプルかつ適切なテストプログラムは、生成物の動作を保障すると同時に、使用法に関してもっともわかりやすく、かつ、"生きのいい"ドキュメントとなる。ワープロソフトでごてごてと色づけされた文書を書く暇があるなら、テストプログラムが本当に適切かどうかを見直した方が、数倍利益があると思うのだ。



どうせプログラマを名乗るんだったら、ソースで語り合おうじゃないか。