読者です 読者をやめる 読者になる 読者になる

プログラマyasuhoの隠れ家

某ソフトウェア企業に勤務するおじさんプログラマyasuhoです

人はなぜコメントを書くのか

コメントを書かないっていうのはちょっと極端な気がするけど、私もコメントは少なめ。

筆者が勤めている会社では、原則、プログラムにコメントを書かないのがルールです。

プログラムにコメント書かない文化もあるよって話 - NZ MoyaSystem

(ズボラだからだけどw)私も基本コメントはあまり書かない。自明であることを書いてもしょうがないしね。「なぜこんなことをする必要があるのか」っていう時に補足として書く。私のコメントの書き方についてはこんな感じ

あと上記記事に書いてないこととして、ソースコードの可読性を上げるため、自明であっても処理ブロックや関数/メソッドごとにコメントを挟むことはよくやる。コメントが全くないソースコードは、なんか窮屈に感じる。まあ好みだとは思うけど。

コメントを書く理由としては

ソースコードの可読性を上げるため、ということになるんだろうけど、個人的には人がコミュニケーションを取りたいからなんだと思っている。誰かに読んでもらいたいんだよね。TODOやFIXME入れておいたり、「なんか分かんないけど、こうしなきゃダメ」とか「なんでこんなことしてんだよ!」とか書いたりね(笑)。コードを通じて会話したいからみんなコメントを書くんじゃないかな。ボクもそう。そういう欲求がなければ、わざわざ面倒なコメントを書いたりしないと思うんだよな。

そういう意味で、人のコメント読むのって好きなんだよね。「ああ、ここはこんなこと考えて書いたのね」とか見えるのが楽しい。無味乾燥なロジックに、書いた人の人間を感じて親近感が湧いてくると、ソースコードを読むことが楽しくなってくるんだ。

え、そんなの私ぐらいですか!? ^^;