コメント｜Javaから楽しく学ぶ！ゲームプログラミング専門学校

プログラミングにおけるコメントとは、プログラムの内容を示した、ソースコード上に記述する注釈のことを言います。

「//」は記述した位置から行末までを、
「/*」 〜 「*/」 で囲った範囲をコメントにするという意味を持ちます。

System.out.println("この文は出力されます。");  //ここからこの行はコメントとなります。



//この行はコメントになります。



/*コメントを複数の行に

またぐこともできます。*/

コメントを書く目的は、時間が経ってからでも、ソースコードの意図を読み取ることを容易にすることにあります。

ソースコードをある程度の時間が経ってから読み返してみると、自分が書いたコードでも、その意図がわかならくなるといった場合が往々にあります。

また、複数人で一つのソフトウェアを作り上げるといった場合、各人が書いたソースコードの意図を読み取るのは非常に困難を極めます。

従って、ソースコードの意図をコメントとしてソースコード上にしっかりと残しておくことは、非常に重要なことです。


Javaにはもう一つ特殊なコメントがあります。
「/**」と「 */」 で囲った場合、Javadocというツールを用いてこのコメントのみを抽出することができます。
Javadocは、クラス設計書などと呼ばれるドキュメントを生成するときに使用されます。