So-net無料ブログ作成

ソースのコメント [プログラミング]

たまたま読んで笑った。
http://d.hatena.ne.jp/coredumped/20060429/1146302177
こういう人いるよねぇ。

私は、年季が入るにつれ、コンパイルが通らないとか言われると、まず自分を疑って「やべっ、オレか?」と思い、反射的に「ごめーん。ちょっと調べてみるねぇ」 とあせるようになってきているが、なぜかいつまでたっても「自分は悪くない」と最初に思う人っているよねぇ。
あと、OS とか、コンパイラとか、よく使われてるライブラリ(glibc とか)が悪いと言い張る人。
プログラミングを始めたばかりならまだしも、いつまでもそう考えちゃう人の思考回路ってどうなってんだろう?ってちょっと思う。

コメントの件について言うと、最近、他人のソースを見ることがないから、こういう経験長いことしてなくて、ちょっと懐かしかった。
最近以前から、ソースにほとんどコメントを書かない私。
「うぁー、コメントが全然ない」と、心の叫びを面と向かって言われたことあり。
ごめんなさい。
でも、

        /* 「あ」と出力する。 */
        printf("あ");


なんて書かれて、その後ソースに修正が入って

        /* 「あ」と出力する。 */
        printf("い");


となってたら、どう思う?
私だったら、「ソースを見るとどう見ても『い』と出力しているように見えるけど、何かのマジックで『あ』と出力できてるんだろうか?」と悩んじゃう(いや、マジで)。

コメントも直せばいいじゃん、っていうのは正論ですが、試しにプログラムを修正してみたらうまく動いたので(コメントは直さず)っていうソースが世の中にはたくさんあるように思います。
上のように、明らかに間違っているコメントや、あまり信用おけないコメントを見てると、だんだんコメントに書いてあることを信用しなくなり(=コメントを読まなくなる)、後に混乱を招くようなコメントは書かないほうがいいってことになっちゃうんです
(↑超いいわけ。本当は適切なコメントをちゃんと書いたほうがいいです)

コメントを書くんだったら、ロジックをそのまま日本語にするようなものじゃなくて
その場のソースを読んでも判らないような前提条件とか、補足説明を書くといいですね。

やたら「たくさんコメントを書くのが良い」という指導が無いほうがいいようなコメントを量産してるんでしょうか?


nice!(0)  コメント(3)  トラックバック(0) 
共通テーマ:パソコン・インターネット

nice! 0

コメント 3

liris

僕もコメントは基本的に書かないです。ソースを読んで分かることをコメントにすると、メンテナンス箇所が増えるだけでいいことはないです。コメントが無いと分からないようなコードは、そのうちメンテナンスできなくなるので、やっぱりリファクタリングすべきです。

> その場のソースを読んでも判らないような前提条件とか、補足説明

には賛成です。

(仕事だと、変なコメントを見付けると消して回ります。)
by liris (2006-05-11 12:12) 

nakagami

>(仕事だと、変なコメントを見付けると消して回ります。)
おおーっ、すげー。
やっぱハッカーは違うなぁ。そこまでしている人はみたことありません。

でも、そういえば私も #if 0 ~ #endif とか、 /* ~ */ で囲って無効にしてあるところのソースを削除することはあります。
liris さんも、ソースに処理を追加していくと総ステップ数が減ってく人ですね。
by nakagami (2006-05-11 13:16) 

しみずかわ

古いコードをコメントアウトして修正コードを入れたコードをソース管理リポジトリにコミットされると、差分を見たときにムキー!ってなりますね。

> liris さんも、ソースに処理を追加していくと総ステップ数が減ってく人ですね。

ステップ数で計測されると進捗マイナスですね(笑
by しみずかわ (2006-05-11 17:52) 

コメントを書く

お名前:
URL:
コメント:
画像認証:
下の画像に表示されている文字を入力してください。

Facebook コメント

トラックバック 0