英語でコメント
最近、プログラムを書くとき、ATOKをONにして日本語で変換するのがめんどくさかったりで、コメントをほとんど英語で書いてる。と書くと、かっこよく聞こえるけど、まともな英語で書ければ、の話で。
数ヶ月前に書いた部分を修正する必要があった。で、ソースを見てみるんだけど、そこにあったコメント。
| Read until data is ok |
えー、書いたのは俺だけど、「はぁ?」って。
付近のソースを解読した結果、「正常なデータが来るまで読み飛ばす」ということらしい。そういう意味だって分かれば雰囲気でてるけど、解読しなきゃ分からないコメントってあんま意味ないじゃん。と。
で、書き直した結果、
| Read and throw away by data is invalid |
うーん。微妙だ。かといって、辞書を引いてとかやってるようじゃ時間短縮って言うそもそもの目的が意味をなさなくなってしまうので、自分で分かる程度の適当英語でいいやと。これもまた数ヶ月後に意味不明になってそうだけど。
ま、今回のとこは酷い例なので、そんなことは頻繁にはない・・・はず。こんなコメントでも無いよりはずっとマシだからなぁ。勢いで一気に開発するようなソフトならともかく、時間をかけてメンテしていくようなのだと、ソースを解読しなきゃ何してるか分からないってのは致命的だからね。
そのためにも、わかりやすいコメントを書かなければ・・・じゃあ日本語で書けよって話だけど。
Posted at 01:31
トラックバック
このサイトまたはページへのリンクを含まないトラックバックは受け付けません。そのチェックのためにトラックバック送信中にタイムアウトになる場合がありますが、確認ができれば正常に受け付けられます。
このエントリーのトラックバックURL:
http://blog.yiza.net/mt-tb.cgi/92