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

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

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

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

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

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

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

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


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

TechTarget発 エンジニア虎の巻

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

Copyright © ITmedia, Inc. All Rights Reserved.

From Informa TechTarget

いまさら聞けない「仮想デスクトップ」と「VDI」の違いとは

いまさら聞けない「仮想デスクトップ」と「VDI」の違いとは
遠隔のクライアント端末から、サーバにあるデスクトップ環境を利用できる仕組みである仮想デスクトップ(仮想PC画面)は便利だが、仕組みが複雑だ。仮想デスクトップの仕組みを基礎から確認しよう。

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

news025.png

「マーケティングオートメーション」 国内売れ筋TOP10(2025年5月)
今週は、マーケティングオートメーション(MA)ツールの売れ筋TOP10を紹介します。

news014.png

「サイト内検索」&「ライブチャット」売れ筋TOP5(2025年4月)
今週は、サイト内検索ツールとライブチャットの国内売れ筋TOP5をそれぞれ紹介します。

news046.png

「ECプラットフォーム」売れ筋TOP10(2025年4月)
今週は、ECプラットフォーム製品(ECサイト構築ツール)の国内売れ筋TOP10を紹介します。