プログラマーが知るべき「良いコメント」の条件【第1回】
「コメント」の“本当の意味”を誤解していないか?
ソースコードにおいて「コメント」は重要だ。ところが内容や意図が分からないコメントはよくある。書き方によっては、自分が書いたコメントさえ“判読不能”になることも。そもそもコメントとは何のためにあるのか。
ソースコードにおける「コメント」は、プログラミングの基本的な要素だ。にもかかわらずプログラマーの間で、コメントの本来の意味が十分に理解されているわけではない。コメントを正しく理解して使いこなせるかどうかが、ソースコードをより良いものにするか、あるいは混乱を招くものにするかの分かれ目となる。
そもそも「コメント」は“あれ”のためにある
ソースコードは、人がコンピュータに動作を指示するためのもの、つまりコンピュータに読んでもらうものだ。ただしソースコード中のコメントに限っては、コンピュータではなく人が読むことが前提となる。
コメントは、ソースコードの該当部分が「何をするか」ではなく「何のためのものか」を伝えるためにある。プログラマーは「それを読めば、プログラム実行時に何が起こるのかが理解できる」コメントを書くことが欠かせない。
コメントを使うことで、プログラマーはソースコードに付加的なテキストを記述できる。プログラマーはコメントで、ソースコードの目的を大まかに説明したり、参考情報を提供したり、バグ修正履歴を記したりすることが可能だ。
次回以降は、悪いコメントおよび良いコメントの例と、コメントを優れたものにするための要件を紹介する。
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
kintoneで実践 製造業のための「見積もり管理」改善のヒント
-
3
「VMware離れ」は本当か 3000社がVCF 9にかじを切った現実的な理由
-
4
MS月例パッチが1000件突破 人手不足の情シスを襲う「月1回メンテ」の崩壊
-
5
「Microsoft一択」で本当にいいのか 知らぬ間にライセンス費用が膨らむ真相
-
6
サーバ約70台をAWSへ ヤナセが移行前にやった「通信要件の可視化」
-
7
脱VMwareの真実:データセンター大手がNutanixを選んだ「コスト以上の理由」
-
8
「Microsoft 365」が乗っ取られる 跡形もなくMFAを破る手口
-
9
100億円の「Linux更新」を回避 みずほ銀行が選んだ“おきて破り”のRHEL延命策
-
10
「AI活用」を掲げた年金刷新が炎上 英政府が大手ITアウトソースを切り捨て「内製回帰」した理由
ホワイトペーパーランキング PR
-
1
生成AIのハルシネーションを防止 回答精度を高めるセマンティックレイヤーとは
-
2
AIエージェントで多様な日常業務を効率化するための入門ガイド
-
3
5回聞くだけじゃ足りない? トヨタ式「なぜなぜ分析」の正しい実践方法
-
4
AIが「わざわざ使うツール」になっていない? 業務で自然に使う導線にする秘訣
-
5
JR西日本ITソリューションズが「監視業務の属人化」を解消した方法とは?
-
6
「脱Excel」か「Excel快適化」か? 現場にやさしい業務改善の進め方
-
7
インシデント対応工数を約3割削減、東京ガスの事例に学ぶ監視体制刷新のコツ
-
8
マンガで解説:「ゼロトラスト」「SASE」の必要性とメリット
-
9
5分で分かる「セキュア大容量ファイル転送サービス」の機能とメリット
-
10
情報セキュリティ対策早分かりガイド:25の自社診断で弱点と解決策を理解
TechTargetジャパン SNS
インフォメーション
注目情報をチェック
TechTargetジャパンをフォロー