コメントの重要性

出典: YKAwiki

コメントは、重要である。

どれくらい重要かというと、コメントがあるとバグが減るし、コメントがあると後から機能を追加するとき以前書いた内容を忘れててもすぐ開発が再開できるし、コメントがあると他の人にデバグを頼むときでも細かいことをいちいち説明しなくて済む、というくらい重要である。逆にコメントがないとバグが増えて再開発が滞り、他人に説明しづらいソースコードができあがる。現に「一週間後の自分は他人と思え」という格言もあるくらいで、プログラミングをしたことのある人ならコメントをマメにつけるものである。

そこで、初心者の方々に申し上げたい。

コメントは、多すぎるくらいでちょうどいい。

実際のところ、コメントは核心を突いたものが一言あれば済むので、例えばfor文で何を回しているかまでは書く必要はない。しかし、初心者のうちはそういう冗長かどうかの判断まではできないことが多い。なので、迷うくらいなら書いたほうがいい。というか、本当に初心者だったらコード一行につき一行コメント書くくらいの勢いでもいい。

そうやってコメントだらけのソースコードを書いているうちに、段々いいコメントというのがどういうものかわかってくるだろう。また、ときどき自分の書いたソースコードを読み返してみるといいだろう。自分の成長の跡が見えるとともに、冗長なコメントが目に付いて恥ずかしくなるだろう。そうなったら、次からはコメントを絞りこみ、洗練させたものにしていけばよい。この文章を読んだ初心者諸君には、そうやって段階を踏んでプログラミングがうまくなって行って欲しいのである。

最後に、もう一度言います。コメントを、つけなさい。