コードにコメントを書くべきか考えてみた

みなさんご機嫌いかがでしょうか。今日はプラグラミングについての話題です。コードにコメント書くべきかどうか、この問題については喧々諤々の議論があるのですが、個人的な立場を述べたいと思います。

コードにコメント書くべきかどうかは人によって意見が分かれるところで、どうしたらいいか迷っちゃいますよね。

調べログ

そこで今日はコードにコメント書くべきか論について私見を述べられたらと。

Contents

コメントは書かなくてもいいという主張もあるけれど。。

そもそもコメント書かなければいけないのはコードが分かりにくいからだ。コードが分かりやすければコメントは書かなくてもいいという主張はありますよね。また、コード見ればわかることをわざわざコメントを書くのはまどろっこしいし時間の無駄なんて意見もありますよね。確かに一理ありますよね。

ただ、この主張はあくまで上級者向けの視点ということで、ちょっと私のようなレベルのものには難易度高い感じはしますね。

自分の書いたコードでもコメントがないと後でみかえしたとき分からなくなる

けっこうよくあることなんですが、公式ドキュメントを参考にコード書いたときに顕著なんですが、後で見返すとあれっ、このコードは。。ってなっちゃうことがあるんですよね。そんな時にコメントがあると、これはこんな意味があるのだなとはっきりするのです。たった一文のコメントでも効果を発揮するので、やっぱりコメントの意義は大きいですね。