プログラマーが知るべき「良いコメント」の条件【第5回】
プログラマーが「駄目なコメント」をソースコードに残さないための5カ条
読んだ人がソースコードを素早く理解しやすくなる「良いコメント」には、幾つかの要件がある。プログラマーが押さえるべき、良いコメントを書くための要件5つを紹介する。
プログラミング言語の要素のうち、プログラマーにとって簡単なようで難しく、奥が深いのが「コメント」だ。自分だけではなく、ソースコードを読んだ全ての人が分かりやすいコメントを書くことは、プログラミングをスムーズに進める上で重要になる。「良いコメント」の条件を、あらためて考えよう。
駄目なコメントではなく「良いコメント」を書く条件
併せて読みたいお薦め記事
連載：プログラマーが知るべき「良いコメント」の条件
- 第1回：「コメント」の“本当の意味”を誤解していないか？
- 第2回：Pythonのソースコードで考える「こんなコメントは無駄なだけで無意味」
- 第3回：「良いコメント」って結局何？ 「悪いコメント」に隠れた“深刻な問題”とは？
- 第4回：Pythonソースコードの実例で分かる「本当に良いコメント」の書き方とは？
ソースコードの書き方
これまで説明してきた内容を、良いコメントを書くための5つの指針としてまとめる。
- ソースコードが「何をするか」ではなく、「何のために書かれたか」を説明する
- ソースコードの内容と重複させない
- 読んだ人を混乱させない
- 簡潔にする
- 自明ではないことを説明する
コメントの書き方のこつをつかめば、より読みやすく、メンテナンスしやすいソースコードを記述できるようになる。有用なコメントは、他のプログラマーがコードベース（ソースコード群）の設計を素早く理解し、同じアイデアや設計に基づいてソースコードを記述する助けになる。
TechTarget発 エンジニア虎の巻
米国TechTargetの豊富な記事の中から、開発のノウハウや技術知識など、ITエンジニアの問題解決に役立つ情報を厳選してお届けします。
Copyright © ITmedia, Inc. All Rights Reserved.
TechTarget発 エンジニア虎の巻
米国TechTargetの豊富な記事の中から、開発のノウハウや技術知識など、ITエンジニアの問題解決に役立つ情報を厳選してお届けします。
この記事の著者
関連記事
新着ホワイトペーパー PR
-
事例
[サイボウズ株式会社] DXに必要な「Dスキル」「Xスキル」を持った人材を育成するには？ -
市場調査・トレンド
[サイボウズ株式会社] データで見る、DXが「順調に進む企業」と「つまずく企業」の違い -
製品資料
[サイボウズ株式会社] 賛否が割れがちな「Notesからの移行」 新環境への移行を納得してもらうには？ -
事例
[ServiceNow Japan合同会社] 農林中金に学ぶ内製開発 処理効率を約2倍に高めAI活用も加速させた方法とは？ -
事例
[ServiceNow Japan合同会社] NTTグループのデジタル変革術、17万人が利用する決裁プロセス刷新の全貌
こんなメディアも見られています
TechTargetジャパンに関連する情報をお探しであれば、こちらのメディアもお役に立てるかもしれません。
ベンダーコンテンツ PR
From Informa TechTarget
SpecialPR
アクセスランキング
-
1
【基本情報技術者試験】「デュプレックスシステム」と「デュアルシステム」の違いは？
-
2
100億円の「Linux更新」を回避 みずほ銀行が選んだ“おきて破り”のRHEL延命策
-
3
MS月例パッチが1000件突破 人手不足の情シスを襲う「月1回メンテ」の崩壊
-
4
サーバ約70台をAWSへ ヤナセが移行前にやった「通信要件の可視化」
-
5
脱VMwareの真実：データセンター大手がNutanixを選んだ「コスト以上の理由」
-
6
「Microsoft一択」で本当にいいのか 知らぬ間にライセンス費用が膨らむ真相
-
7
「データストレージの活用方法」に関するアンケート
-
8
「VMware離れ」は本当か 3000社がVCF 9にかじを切った現実的な理由
-
9
AIインフラの理想形？ 「5層のケーキ」を垂直統合するための近道とは
-
10
多品種小ロットの「手書き・配合ミス」を克服 キャニオンスパイスの食品工場DX
ホワイトペーパーランキング PR
-
1
生成AIのハルシネーションを防止 回答精度を高めるセマンティックレイヤーとは
-
2
5回聞くだけじゃ足りない？ トヨタ式「なぜなぜ分析」の正しい実践方法
-
3
AIエージェントで多様な日常業務を効率化するための入門ガイド
-
4
インシデント対応工数を約3割削減、東京ガスの事例に学ぶ監視体制刷新のコツ
-
5
「脱Excel」か「Excel快適化」か？ 現場にやさしい業務改善の進め方
-
6
マンガで解説：「ゼロトラスト」「SASE」の必要性とメリット
-
7
5分で分かる「セキュア大容量ファイル転送サービス」の機能とメリット
-
8
情報セキュリティ対策早分かりガイド：25の自社診断で弱点と解決策を理解
-
9
国税庁の次世代基幹システム「KSK2」稼働開始に向けて、対応すべき変更点とは？
-
10
AIが「わざわざ使うツール」になっていない？ 業務で自然に使う導線にする秘訣
TechTargetジャパン SNS
@techtarget_itmをフォロー
インフォメーション
注目情報をチェック
TechTargetジャパンをフォロー