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

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

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

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

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

会員登録(無料)が必要です

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

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

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

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


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

TechTarget発 エンジニア虎の巻

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

Copyright © ITmedia, Inc. All Rights Reserved.

新着ホワイトペーパー

事例 Twilio Japan合同会社

物流DX支援企業に学ぶ、「現場の声」をプロダクト開発に随時反映する秘訣

物流向けアプリケーションの開発を行うMeeTruckでは、アジャイル開発でPDCAをスピーディーに回すことで、業界での支持を拡大している。そんな同社の躍進を支えているのが、豊富なAPIを誇るコミュニケーションプラットフォームだ。

事例 Twilio Japan合同会社

SMS認証機能を2日程度で実現、事例に学ぶスピード実装の秘訣

斬新なアイデアで人気を博すレシート買い取りアプリ「ONE」を提供するWEDでは、認証機能の開発工数を削減すべく、あるクラウドコミュニケーションAPIを導入した。SMS認証機能の実装をわずか2日程度で実現した同ツールの実力を紹介する。

製品レビュー アステリア株式会社

建設現場のDXを促進、 IT人材不足でも現場でのアプリ開発で業務効率向上

アナログで非効率な業務が多く残る建設現場では、デジタル化によるプロセス改善が、喫緊の課題となっている。現場DXを推進する具体的な方法を提案するとともに、ノーコードツールの導入で大きな成果を収めた事例を紹介する。

事例 アステリア株式会社

「DXへの意識が低い」中小企業が現場DXを推進、事例に学ぶノーコード活用の秘訣

ビルメンテナンス事業を展開する裕生では、全社的にDXへの意識が低く、従業員の意識改革に課題を抱えていた。そこで、取り組みの契機とすべくノーコードツールを導入。業務アプリの活用により現場の業務はどのように変化したのだろうか。

製品資料 アステリア株式会社

業務アプリ開発を効率化するノーコード開発、スクラッチ開発と何がどう違う?

深刻化するIT人材不足の課題解消の方法として、プログラミングコードを書かずに業務用モバイルアプリを開発できる「ノーコード開発」が注目されている。従来のスクラッチ開発との違いを比較し、メリットや導入のポイントを解説する。

From Informa TechTarget

いまさら聞けない「仮想デスクトップ」と「VDI」の違いとは

いまさら聞けない「仮想デスクトップ」と「VDI」の違いとは
遠隔のクライアント端末から、サーバにあるデスクトップ環境を利用できる仕組みである仮想デスクトップ(仮想PC画面)は便利だが、仕組みが複雑だ。仮想デスクトップの仕組みを基礎から確認しよう。

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

news014.png

「サイト内検索」&「ライブチャット」売れ筋TOP5(2025年4月)
今週は、サイト内検索ツールとライブチャットの国内売れ筋TOP5をそれぞれ紹介します。

news046.png

「ECプラットフォーム」売れ筋TOP10(2025年4月)
今週は、ECプラットフォーム製品(ECサイト構築ツール)の国内売れ筋TOP10を紹介します。

news026.png

「パーソナライゼーション」&「A/Bテスト」ツール売れ筋TOP5(2025年4月)
今週は、パーソナライゼーション製品と「A/Bテスト」ツールの国内売れ筋各TOP5を紹介し...