プログラマーが知るべき「良いコメント」の条件【第5回】
プログラマーが「駄目なコメント」をソースコードに残さないための5カ条
読んだ人がソースコードを素早く理解しやすくなる「良いコメント」には、幾つかの要件がある。プログラマーが押さえるべき、良いコメントを書くための要件5つを紹介する。
プログラミング言語の要素のうち、プログラマーにとって簡単なようで難しく、奥が深いのが「コメント」だ。自分だけではなく、ソースコードを読んだ全ての人が分かりやすいコメントを書くことは、プログラミングをスムーズに進める上で重要になる。「良いコメント」の条件を、あらためて考えよう。
駄目なコメントではなく「良いコメント」を書く条件
併せて読みたいお薦め記事
連載：プログラマーが知るべき「良いコメント」の条件
- 第1回：「コメント」の“本当の意味”を誤解していないか？
- 第2回：Pythonのソースコードで考える「こんなコメントは無駄なだけで無意味」
- 第3回：「良いコメント」って結局何？ 「悪いコメント」に隠れた“深刻な問題”とは？
- 第4回：Pythonソースコードの実例で分かる「本当に良いコメント」の書き方とは？
ソースコードの書き方
これまで説明してきた内容を、良いコメントを書くための5つの指針としてまとめる。
- ソースコードが「何をするか」ではなく、「何のために書かれたか」を説明する
- ソースコードの内容と重複させない
- 読んだ人を混乱させない
- 簡潔にする
- 自明ではないことを説明する
コメントの書き方のこつをつかめば、より読みやすく、メンテナンスしやすいソースコードを記述できるようになる。有用なコメントは、他のプログラマーがコードベース（ソースコード群）の設計を素早く理解し、同じアイデアや設計に基づいてソースコードを記述する助けになる。
TechTarget発 エンジニア虎の巻
米国TechTargetの豊富な記事の中から、開発のノウハウや技術知識など、ITエンジニアの問題解決に役立つ情報を厳選してお届けします。
Copyright © ITmedia, Inc. All Rights Reserved.
TechTarget発 エンジニア虎の巻
米国TechTargetの豊富な記事の中から、開発のノウハウや技術知識など、ITエンジニアの問題解決に役立つ情報を厳選してお届けします。
この記事の著者
関連記事
新着ホワイトペーパー PR
-
事例
[フォーティネットジャパン合同会社] 複雑化しがちな「SASE運用」 IT・医療・金融などの事例に見る導入成功の秘訣 -
製品資料
[フォーティネットジャパン合同会社] 「SD-WAN」導入で失敗しないための5つの重要事項 -
技術文書・技術解説
[フォーティネットジャパン合同会社] VPNの代替候補「ZTNA」を理解できるようになる“3大要素”とは？ -
事例
[フォーティネットジャパン合同会社] すぐ分かる「SD-WAN」選定のポイント 成功企業はどんな成果を出した？ -
製品資料
[SCSK株式会社] 「Dropbox」管理・運用の困りごと解決ガイド
こんなメディアも見られています
TechTargetジャパンに関連する情報をお探しであれば、こちらのメディアもお役に立てるかもしれません。
ベンダーコンテンツ PR
From Informa TechTarget
SpecialPR
アクセスランキング
-
1
半数がブルーカラー転向を視野に？ ベテランエンジニアを追い込む“54歳の壁”
-
2
PHP脆弱性「PHP2Shell」で2260万件に影響 情シスの緊急チェックリスト
-
3
みずほ証券が「液冷サーバ」を採用 1日3.6億件の計算を支えるための要件
-
4
「Microsoft 365」が乗っ取られる MFAを破る“本物の画面”の恐怖
-
5
「Windows」の不要なファイルを安全に消して容量を空ける方法
-
6
Microsoft月例パッチ1400件超で過去最多 「限界点」を迎えたパッチ管理
-
7
損保ジャパンはなぜ「COBOL」を捨てなかったのか？ 脱メインフレームの真相
-
8
RAGで「データをAIに送る」運用が限界を迎えている理由
-
9
SAP導入後も残る“Excel依存” 京急電鉄は「kintone」でどう解消した？
-
10
なぜ「Gemini 4 Argon」は出遅れたのか？ Googleが狙う“逆転のシナリオ”
ホワイトペーパーランキング PR
-
1
AI駆動攻撃にどう対抗する？ 超速の攻撃からエンドポイントを保護する方法
-
2
2026年のサイバーセキュリティには何が必要か？ 最新データに学ぶ傾向と対策
-
3
経験豊富な即戦力人材に直接アプローチできる、「攻めの採用」への転換術
-
4
「IT史に名を残すシステム障害」8選
-
5
最速72分でデータが流出？ 最新の脅威トレンドや侵入手法から分かった防衛策
-
6
AI駆動開発のスピードと安全性を両立 「品質・セキュリティ管理」の実践ガイド
-
7
不審メールの経路や見せ方に変化？ 2026年夏の3事例から見えた動向と対処方法
-
8
HDDを使わない「SSDオンリー」が無謀なのはなぜ？
-
9
「標的型攻撃メール」事例・サンプル集
-
10
Microsoft 365のメールセキュリティ、3つの“死角”と追加で検討すべき対策とは
TechTargetジャパン SNS
@techtarget_itmをフォロー
インフォメーション
注目情報をチェック
TechTargetジャパンをフォロー