「良いコメント」って結局何? 「悪いコメント」に隠れた“深刻な問題”とは?プログラマーが知るべき「良いコメント」の条件【第3回】

プログラマーが書くコメントの良しあしは、自分だけではなく、他のプログラマーの生産性にも影響を及ぼす。「良いコメント」とはどのようなものなのか。「悪いコメント」はなぜ駄目なのか。

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

 「良いソースコード」を書きたいと考えているプログラマーにとって、決して軽視できないのが「コメント」だ。どれほど優れたプログラムを実現するソースコードでも、適切なコメントがないと、デバッグや機能追加といったメンテナンスがしにくい“駄目なソースコード”になってしまう可能性がある。

「良いコメント」の条件と「悪いコメント」に隠れた深刻な問題

 良いコメントとは「読んだ人が、ソースコードが定義する処理を大まかに理解でき、全体の流れが分かる」コメントだと言える。そのようなコメントを含むソースコードは、コードベース(ソースコード群)や使用中のフレームワーク(特定の設計思想を具現化するプログラム部品やドキュメントの集合体)を詳細まで理解する助けになる。

 複雑で特殊なソースコードを要約するコメントは、ソースコードのレビューやメンテナンスの時間短縮の一助となる。適切なコメントやソースコードは、プログラマーがレビューやメンテナンスに必要な情報を簡単に理解できるようにする。

 良いコメントの別の要件として「簡潔である」ことが挙げられる。簡潔なコメントを書くのに苦労するのであれば、ソースコード全体に問題がある可能性がある。そうした場合は、ソースコードの構成を見直すとよい。

 複雑過ぎるソースコードは読みづらく、コメントを挿入するのに苦労する。説明しやすいソースコードにリファクタリング(動作を変えないままの内部構造修正)をすることで、他の人がソースコードを素早く理解できるようになり、ソースコードのメンテナンスもしやすくなる。


 次回は、実例を交えて「良いコメント」とは何かを考える。

TechTarget発 エンジニア虎の巻

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

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

news025.png

「マーケティングオートメーション」 国内売れ筋TOP10(2024年3月)
今週は、マーケティングオートメーション(MA)ツールの売れ筋TOP10を紹介します。

news175.png

AI同士が議論して商品開発のアイデア出し 博報堂が「マルチエージェント ブレストAI」の業務活用を開始
専門知識を持ったAI同士が協調して意思決定と企画生成を行う仕組みを活用。最適な結論や...

news172.jpg

デジタルサイネージ一体型自動ドアによる広告配信サービス ナブテスコが提供
ナブテスコがデジタルサイネージ一体型自動ドアを広告メディアとして利用する新サービス...