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

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

2023年07月09日 09時30分 公開
[Matthew GrasbergerTechTarget]

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

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

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

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

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

TechTarget発 エンジニア虎の巻

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

ITmedia マーケティング新着記事

news074.jpg

ニップンと刀が協業 マーケティングノウハウで成熟市場を拡大へ
ニップンと刀は「ニップン × 刀 協業発表会」を開催し、協業を通じた両社の取り組みとそ...

news197.png

広告運用自動化ツール「Shirofune」がMicrosoft広告の改善機能を実装
Shirofuneは広告運用自動化ツール「Shirofune」に改善カード機能を追加。これにより、キ...

news192.jpg

インテージ、「YouTube Select」「YouTube Shorts」における態度変容調査を提供開始
広告効果測定サービス「Brand Impact Scope」をバージョンアップし、サンプルサイズと計...