プログラマーが「駄目なコメント」をソースコードに残さないための5カ条：プログラマーが知るべき「良いコメント」の条件【第5回】

読んだ人がソースコードを素早く理解しやすくなる「良いコメント」には、幾つかの要件がある。プログラマーが押さえるべき、良いコメントを書くための要件5つを紹介する。

[Matthew Grasberger，TechTarget]

　プログラミング言語の要素のうち、プログラマーにとって簡単なようで難しく、奥が深いのが「コメント」だ。自分だけではなく、ソースコードを読んだ全ての人が分かりやすいコメントを書くことは、プログラミングをスムーズに進める上で重要になる。「良いコメント」の条件を、あらためて考えよう。

駄目なコメントではなく「良いコメント」を書く条件

併せて読みたいお薦め記事

連載：プログラマーが知るべき「良いコメント」の条件

• 第1回：「コメント」の“本当の意味”を誤解していないか？
• 第2回：Pythonのソースコードで考える「こんなコメントは無駄なだけで無意味」
• 第3回：「良いコメント」って結局何？　「悪いコメント」に隠れた“深刻な問題”とは？
• 第4回：Pythonソースコードの実例で分かる「本当に良いコメント」の書き方とは？

ソースコードの書き方

• 「Python」と「Go」のソースコードを比べて分かる「インデント」の違いとは？
• 命令型プログラミングと宣言型プログラミングの「ソースコード」の違いとは？

　これまで説明してきた内容を、良いコメントを書くための5つの指針としてまとめる。

1. ソースコードが「何をするか」ではなく、「何のために書かれたか」を説明する
2. ソースコードの内容と重複させない
3. 読んだ人を混乱させない
4. 簡潔にする
5. 自明ではないことを説明する

　コメントの書き方のこつをつかめば、より読みやすく、メンテナンスしやすいソースコードを記述できるようになる。有用なコメントは、他のプログラマーがコードベース（ソースコード群）の設計を素早く理解し、同じアイデアや設計に基づいてソースコードを記述する助けになる。

TechTarget発　エンジニア虎の巻

米国TechTargetの豊富な記事の中から、開発のノウハウや技術知識など、ITエンジニアの問題解決に役立つ情報を厳選してお届けします。