プログラマーが書くコメントの良しあしは、自分だけではなく、他のプログラマーの生産性にも影響を及ぼす。「良いコメント」とはどのようなものなのか。「悪いコメント」はなぜ駄目なのか。
「良いソースコード」を書きたいと考えているプログラマーにとって、決して軽視できないのが「コメント」だ。どれほど優れたプログラムを実現するソースコードでも、適切なコメントがないと、デバッグや機能追加といったメンテナンスがしにくい“駄目なソースコード”になってしまう可能性がある。
良いコメントとは「読んだ人が、ソースコードが定義する処理を大まかに理解でき、全体の流れが分かる」コメントだと言える。そのようなコメントを含むソースコードは、コードベース(ソースコード群)や使用中のフレームワーク(特定の設計思想を具現化するプログラム部品やドキュメントの集合体)を詳細まで理解する助けになる。
複雑で特殊なソースコードを要約するコメントは、ソースコードのレビューやメンテナンスの時間短縮の一助となる。適切なコメントやソースコードは、プログラマーがレビューやメンテナンスに必要な情報を簡単に理解できるようにする。
良いコメントの別の要件として「簡潔である」ことが挙げられる。簡潔なコメントを書くのに苦労するのであれば、ソースコード全体に問題がある可能性がある。そうした場合は、ソースコードの構成を見直すとよい。
複雑過ぎるソースコードは読みづらく、コメントを挿入するのに苦労する。説明しやすいソースコードにリファクタリング(動作を変えないままの内部構造修正)をすることで、他の人がソースコードを素早く理解できるようになり、ソースコードのメンテナンスもしやすくなる。
次回は、実例を交えて「良いコメント」とは何かを考える。
米国TechTargetの豊富な記事の中から、開発のノウハウや技術知識など、ITエンジニアの問題解決に役立つ情報を厳選してお届けします。
Copyright © ITmedia, Inc. All Rights Reserved.
お知らせ
米国TechTarget Inc.とInforma Techデジタル事業が業務提携したことが発表されました。TechTargetジャパンは従来どおり、アイティメディア(株)が運営を継続します。これからも日本企業のIT選定に役立つ情報を提供してまいります。
「パーソナライゼーション」&「A/Bテスト」ツール売れ筋TOP5(2025年4月)
今週は、パーソナライゼーション製品と「A/Bテスト」ツールの国内売れ筋各TOP5を紹介し...
Cookieを超える「マルチリターゲティング」 広告効果に及ぼす影響は?
Cookieレスの課題解決の鍵となる「マルチリターゲティング」を題材に、AI技術によるROI向...
「マーケティングオートメーション」 国内売れ筋TOP10(2025年4月)
今週は、マーケティングオートメーション(MA)ツールの売れ筋TOP10を紹介します。