コメントの付け方

この節の要点

• プログラム中のコメントはC言語と同様に//でそれ以降の行末までをコメントとして扱うか、/*で始まり、*/で終わる範囲をコメントとして扱うかの2種類の構文がある。
• /**で始まり、*/で終わる範囲はJavaDocコメントと呼ばれ、IDEが(メソッドの説明表示などで)利用する特殊なコメントである。

Hello,World.の節で作成したプログラムにおいても、ひな型の段階からありましたが、プログラム文中に、プログラム本文ではないコメント文を残したい場合、図5のように記述します。

/* スラッシュコロンからコロンスラッシュまでの文章はプログラムとして解釈されません。
*/

/**
 * スラッシュコロンコロンから始まる文章は、特別なコメント文でJavaDocコメントとよばれます。このコメント文の目的は直後の行の説明ですが、単純なコメント文との違いは、この種類のコメントを抽出してプログラムの説明文章(JavaDoc)を作成することができます。
 */
public static void main(String[] args) {
	// スラッシュスラッシュ以降の行末までの文章はプログラムとして解釈されません。
	System.out.println("Hello,World.");
}

図5に記載してあるコメントのうち、JavaDocコメント は特殊なコメント文です。/**(スラッシュコロンコロン)から始まるこのコメント文は、そのクラスが何をするクラスか、そのメソッドが何をするメソッドか、その変数が何のための変数か、を記述するために使います。ただこのままでは、単純なコメント文と大差ありません。JavaDocコメントはそれを抽出することでプログラムの仕様文章を記述することが、真の目的です。

たとえば、NetBeansのようなエディタやコンパイラやその他支援ツールなどが1つにまとまったソフトウェアである統合開発環境(IDE )であれば、これから使おうとしているメソッドがどんなメソッドか、エディタ上でJavaDocコメントをポップアップで表示させることができます。

NetBeansにおいては、JavaDocが見たいクラス名やメソッド名にテキストカーソルを合わせてCtrl+Shift+Spaceを入力すると、図6や図7のようにJavaDocコメントを装飾して表示させることができます。

自身が書いたJavaDocコメントだけでなく、他者によって既に書かれているJavaDocコメントも閲覧できます。たとえば図7のように、使うメソッドが何をするか、引数(パラメータ)は何か、返り値は何か、といった情報を、英語ではありますが表示できます。