コメント
Javaのコメントは3種類の書き方ができます.
一行コメント
//
以降改行までがコメントとして扱われます.
例
Integer answer = 1 + 1; // この部分がコメント.
// 改行すると別のコメントとして扱われるため,再度コメント記号が必要.
通常コメント
/*
と */
で囲まれた部分がコメントとして扱われます.
C言語と同じスタイルです.
このコメントを入れ子にすることはできません.
例
/* この部分がコメントです. */
/* この部分がコメントです.
複数行に分かれていてもOK! */
Integer answer = 1 + 1;
/* この部分がコメントです.
Integer answer = 1 + 1; // 途中に1行コメントが含まれていてもOK
*/
Javadoc コメント
/**
と */
で囲まれた部分がコメントとして扱われます.
通常コメントと同じような書き方ですが,このコメントが書ける場所は次の3つに限られています.
次の3つ以外の場所にJavadocコメントが書かれると通常コメントとして扱われます.
- クラス宣言の前,
- メソッド宣言の前.
- フィールド宣言の前.
- フィールド宣言とは,クラス宣言の内側,かつ,メソッド宣言の外側で定義された変数を指します.
javadoc
コマンドにより,ソースファイルからドキュメントを生成できますが,その時にドキュメントに掲載する文章をこのコメントで記します.
この授業では扱いません.
例
/**
* クラスに対するJavadocコメント.
* このクラスの役割などを書く.
*/
public class SampleClass{
/**
* フィールドに対するJavadocコメント.
* このフィールドの役割などを書く.
*/
String stringField = "string"; // フィールドの宣言
/**
* メソッドに対するJavadocコメント.
* このメソッドの役割などを書く.
*/
public static void main(String[] args){
// 何らかの処理.
}
}