プログラマーが知るべき「良いコメント」の条件【第1回】
「コメント」の“本当の意味”を誤解していないか?
ソースコードにおいて「コメント」は重要だ。ところが内容や意図が分からないコメントはよくある。書き方によっては、自分が書いたコメントさえ“判読不能”になることも。そもそもコメントとは何のためにあるのか。
ソースコードにおける「コメント」は、プログラミングの基本的な要素だ。にもかかわらずプログラマーの間で、コメントの本来の意味が十分に理解されているわけではない。コメントを正しく理解して使いこなせるかどうかが、ソースコードをより良いものにするか、あるいは混乱を招くものにするかの分かれ目となる。
そもそも「コメント」は“あれ”のためにある
ソースコードは、人がコンピュータに動作を指示するためのもの、つまりコンピュータに読んでもらうものだ。ただしソースコード中のコメントに限っては、コンピュータではなく人が読むことが前提となる。
コメントは、ソースコードの該当部分が「何をするか」ではなく「何のためのものか」を伝えるためにある。プログラマーは「それを読めば、プログラム実行時に何が起こるのかが理解できる」コメントを書くことが欠かせない。
コメントを使うことで、プログラマーはソースコードに付加的なテキストを記述できる。プログラマーはコメントで、ソースコードの目的を大まかに説明したり、参考情報を提供したり、バグ修正履歴を記したりすることが可能だ。
次回以降は、悪いコメントおよび良いコメントの例と、コメントを優れたものにするための要件を紹介する。
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
Microsoft月例パッチ1400件超で過去最多 「限界点」を迎えたパッチ管理
-
3
SAP導入後も残る“Excel依存” 京急電鉄は「kintone」でどう解消した?
-
4
「Microsoft 365」が乗っ取られる MFAを破る“本物の画面”の恐怖
-
5
生成AIが普及しても「技術書」を手放せないエンジニアの本音
-
6
「エージェントを作るな、スキルを作れ?」 Anthropicが提唱するAI運用の勘所
-
7
RAGで「データをAIに送る」運用が限界を迎えている理由
-
8
なぜ人はいるのにDXが進まない? ライオンも直面した“老害”レガシーシステム
-
9
PHP脆弱性「PHP2Shell」で2260万件に影響 情シスの緊急チェックリスト
-
10
Claude利用8割のGMO、AI人材の評価軸が「トークン管理」に変わった
ホワイトペーパーランキング 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ジャパンをフォロー