プログラマーが知るべき「良いコメント」の条件【第5回】
プログラマーが「駄目なコメント」をソースコードに残さないための5カ条
読んだ人がソースコードを素早く理解しやすくなる「良いコメント」には、幾つかの要件がある。プログラマーが押さえるべき、良いコメントを書くための要件5つを紹介する。
プログラミング言語の要素のうち、プログラマーにとって簡単なようで難しく、奥が深いのが「コメント」だ。自分だけではなく、ソースコードを読んだ全ての人が分かりやすいコメントを書くことは、プログラミングをスムーズに進める上で重要になる。「良いコメント」の条件を、あらためて考えよう。
駄目なコメントではなく「良いコメント」を書く条件
併せて読みたいお薦め記事
連載：プログラマーが知るべき「良いコメント」の条件
- 第1回：「コメント」の“本当の意味”を誤解していないか？
- 第2回：Pythonのソースコードで考える「こんなコメントは無駄なだけで無意味」
- 第3回：「良いコメント」って結局何？ 「悪いコメント」に隠れた“深刻な問題”とは？
- 第4回：Pythonソースコードの実例で分かる「本当に良いコメント」の書き方とは？
ソースコードの書き方
これまで説明してきた内容を、良いコメントを書くための5つの指針としてまとめる。
- ソースコードが「何をするか」ではなく、「何のために書かれたか」を説明する
- ソースコードの内容と重複させない
- 読んだ人を混乱させない
- 簡潔にする
- 自明ではないことを説明する
コメントの書き方のこつをつかめば、より読みやすく、メンテナンスしやすいソースコードを記述できるようになる。有用なコメントは、他のプログラマーがコードベース（ソースコード群）の設計を素早く理解し、同じアイデアや設計に基づいてソースコードを記述する助けになる。
TechTarget発 エンジニア虎の巻
米国TechTargetの豊富な記事の中から、開発のノウハウや技術知識など、ITエンジニアの問題解決に役立つ情報を厳選してお届けします。
Copyright © ITmedia, Inc. All Rights Reserved.
TechTarget発 エンジニア虎の巻
米国TechTargetの豊富な記事の中から、開発のノウハウや技術知識など、ITエンジニアの問題解決に役立つ情報を厳選してお届けします。
この記事の著者
関連記事
こんなメディアも見られています
TechTargetジャパンに関連する情報をお探しであれば、こちらのメディアもお役に立てるかもしれません。
ベンダーコンテンツ PR
From Informa TechTarget
SpecialPR
アクセスランキング
-
1
急増する「AIはこう言ってる」マン 判断を狂わせる「AI忖度」を防ぐには？
-
2
取手市がVDIと決別した理由 更改費用「4倍超」を約1.7倍に圧縮
-
3
「データストレージの活用方法」に関するアンケート
-
4
自宅のWi-Fiが「遅い」「途切れる」本当の原因は？ Dellが推奨する鉄則
-
5
本当に安いPCで十分か？ “すぐ重くなる”を防ぐノートPC選びの絶対条件
-
6
Claudeの不可視透かしに批判殺到 著作権消失や誤判定に潜む企業リスク
-
7
100億円の「Linux更新」を回避 みずほ銀行が選んだ“おきて破り”のRHEL延命策
-
8
221人調査で分かった「情シス最大のストレス」は？
-
9
LLMの「過学習」、正しく説明している文章はどれ？
-
10
レガシー基幹システムをSAPに統合 山善が突き止めた「標準化と個別最適」の境界線
ホワイトペーパーランキング PR
-
1
年収2000万「クラウドセキュリティのプロ」になれる資格とは
-
2
セキュリティソフトをすり抜ける標的型攻撃メール、不審メールの見破り方とは？
-
3
Windows Updateの通信集中で回線が逼迫、ネットワーク刷新事例に学ぶ解決策
-
4
財務を戦略的組織へ進化させるAI活用術、4つの主要な障壁と解消方法
-
5
「NAS」「SAN」「DAS」は何が違う？ いまさら聞けないストレージの基礎
-
6
“あのファイル転送”で暗躍するノーウェアランサム
-
7
標的型攻撃メールを見破るには？ サンプル文面を例に傾向を解説
-
8
商用利用の安全性を確保し大量のコンテンツを高速で生成する、AI活用の秘訣
-
9
マンガで解説、1日で生成AI環境を構築できるワークショップの中身とは？
-
10
Dark AIが台頭する時代の新発想、「より高度なAIで対抗する」具体的方法とは？
TechTargetジャパン SNS
@techtarget_itmをフォロー
インフォメーション
注目情報をチェック
TechTargetジャパンをフォロー