「コメント」の“本当の意味”を誤解していないか?プログラマーが知るべき「良いコメント」の条件【第1回】

ソースコードにおいて「コメント」は重要だ。ところが内容や意図が分からないコメントはよくある。書き方によっては、自分が書いたコメントさえ“判読不能”になることも。そもそもコメントとは何のためにあるのか。

2023年06月10日 10時00分 公開
[Matthew GrasbergerTechTarget]

 ソースコードにおける「コメント」は、プログラミングの基本的な要素だ。にもかかわらずプログラマーの間で、コメントの本来の意味が十分に理解されているわけではない。コメントを正しく理解して使いこなせるかどうかが、ソースコードをより良いものにするか、あるいは混乱を招くものにするかの分かれ目となる。

そもそも「コメント」は“あれ”のためにある

 ソースコードは、人がコンピュータに動作を指示するためのもの、つまりコンピュータに読んでもらうものだ。ただしソースコード中のコメントに限っては、コンピュータではなく人が読むことが前提となる。

 コメントは、ソースコードの該当部分が「何をするか」ではなく「何のためのものか」を伝えるためにある。プログラマーは「それを読めば、プログラム実行時に何が起こるのかが理解できる」コメントを書くことが欠かせない。

 コメントを使うことで、プログラマーはソースコードに付加的なテキストを記述できる。プログラマーはコメントで、ソースコードの目的を大まかに説明したり、参考情報を提供したり、バグ修正履歴を記したりすることが可能だ。


 次回以降は、悪いコメントおよび良いコメントの例と、コメントを優れたものにするための要件を紹介する。

TechTarget発 エンジニア虎の巻

米国TechTargetの豊富な記事の中から、開発のノウハウや技術知識など、ITエンジニアの問題解決に役立つ情報を厳選してお届けします。

ITmedia マーケティング新着記事

news131.jpg

メッシやベリンガム、ヴィルツも登場 アディダスが世界で展開する豪華過ぎるサッカー推しキャンペーンの中身
Adidasが夏のサッカーシーズンに向けて新キャンペーンを世界各地で展開する。デビッド・...

news058.jpg

Web広告施策に課題を感じている企業は9割以上――リンクアンドパートナーズ調査
企業のWeb広告施策を推進している担当者約500人を対象に、課題と今後の取り組みについて...

news183.jpg

TikTokマーケティングの最適解へ スパイスボックスが縦型動画クリエイター集団M2DKと業務提携
スパイスボックスが縦型動画クリエイター集団であるM2DKと業務提携。生活者に向けて訴求...