2.2 コメント

通常、プログラムのソースコードは、ビジネスアプリケーションの場合は数千行から数万行、市販用のゲームプログラムや管理システムなどは数十万行に及ぶことがあります。このような大きなプログラムの場合、書いているときは問題ありませんが、後で読み直すとき、プログラムを改変しなければならなくなった時に、コードが何を行っているのかわからなくなることがあります。

または、オープンソースのような第三者に公開するプログラムや数人のプログラマによる共同作業の場合も同様で、開発者本人以外がソースコードを読んだとき、それが何を意味しているのかを理解するのが難しいことは、めずらしいことではありません。

こうした問題を少しでも解決するために、開発者は自分の書いたコードにコメントを残すことが推奨されています。コメントとは、コンパイル時には完全に無視される、プログラムには関係ない注釈文のことです。

Java 言語のコメントは、次の2種類が用意されています。

/* 注釈テキスト */

// 注釈テキスト

前者のコメントは C 言語で使われる コメントとまったく同じものです。コンパイル時には /* から */ までのすべてのテキストが無視されます。このコメントは、行をまたがっても良いという点が特徴です。

後者は一行コメントと呼ばれ、// から行末までのテキストが無視されます。

class Test {
	//ここからプログラムがスタートします
	public static void main(String args[]) {
		System.out.println("Kitty on your lap");
/*
		"Kitty on your lap"
		これは、筆者が hello world の代わりに使っている
		出力テスト用の文字列なのです
*/
	}
}

>java Test
Kitty on your lap

コード1は、2.1 はじめてのJava言語.コード2と結果が同じですが、ソース内にコメントを残している点で異なります。コメント部分はコンパイルするときに無視されるため、生成されるクラスファイルは2.1 はじめてのJava言語.コード2とまったく同じものであると考えてかまいません。

ただし、プログラミングのスペシャリストを目指す場合は、コメントを積極的に残すという習慣のさらに上を目指さなければならないことを忘れてはなりません。一流のプログラマが記述した良質のプログラムは、コメントが無くてもコードそのものがすべてを語ってくれます。つまり、コメントが無くてもある程度は読むことができる、可読性の高いコードを記述するように心がけることも大切なのです。