ソースコードにおいて「コメント」は重要だ。ところが内容や意図が分からないコメントはよくある。書き方によっては、自分が書いたコメントさえ“判読不能”になることも。そもそもコメントとは何のためにあるのか。
ソースコードにおける「コメント」は、プログラミングの基本的な要素だ。にもかかわらずプログラマーの間で、コメントの本来の意味が十分に理解されているわけではない。コメントを正しく理解して使いこなせるかどうかが、ソースコードをより良いものにするか、あるいは混乱を招くものにするかの分かれ目となる。
ソースコードは、人がコンピュータに動作を指示するためのもの、つまりコンピュータに読んでもらうものだ。ただしソースコード中のコメントに限っては、コンピュータではなく人が読むことが前提となる。
コメントは、ソースコードの該当部分が「何をするか」ではなく「何のためのものか」を伝えるためにある。プログラマーは「それを読めば、プログラム実行時に何が起こるのかが理解できる」コメントを書くことが欠かせない。
コメントを使うことで、プログラマーはソースコードに付加的なテキストを記述できる。プログラマーはコメントで、ソースコードの目的を大まかに説明したり、参考情報を提供したり、バグ修正履歴を記したりすることが可能だ。
次回以降は、悪いコメントおよび良いコメントの例と、コメントを優れたものにするための要件を紹介する。
米国TechTargetの豊富な記事の中から、開発のノウハウや技術知識など、ITエンジニアの問題解決に役立つ情報を厳選してお届けします。
Copyright © ITmedia, Inc. All Rights Reserved.
お知らせ
米国TechTarget Inc.とInforma Techデジタル事業が業務提携したことが発表されました。TechTargetジャパンは従来どおり、アイティメディア(株)が運営を継続します。これからも日本企業のIT選定に役立つ情報を提供してまいります。
2025年のバレンタインのトレンドを購買実態から分析 「カカオショック」の影響は?
読売広告社は、ショッパーインサイトの食品ID-POS購買行動データベース「real shopper SM...
生成AIへの期待値の変化 DeepSeek台頭がマーケターに突きつける課題とは?
AI 生成の広告に対する反発が続いた1年を経て、マーケターはパフォーマンス結果重視で非...
2024年に視聴者が検索したテレビCM 2位は中国のあのEVメーカー、1位は?
2024年にテレビCMを通して視聴者が気になりWeb検索したものは何だったのか。ノバセルが発...