ここでは Javadoc に記載するコメントの例を示します。
constructor でなにもしないケース
/**
* 新しい Class オブジェクトを構築します。
*/
public Class() {
super();
}
constructor で初期値を設定するケース
/**
* 初期化された新しい Class オブジェクトを構築します。
*/
public Class() {
super();
fieldName = value;
}
/**
* 指定された param1 を持つ、新しい Class オブジェクトを構築します。
*
* @param param1
*/
public Class(final String param1) {
super();
this.param1 = param1;
}
/**
* 指定された param1 と param2 を持つ、新しい Class オブジェクトを構築します。
*
* @param param1
* @param param2
*/
public Class(final String param1, final String param2) {
super();
this.param1 = param1;
this.param2 = param2;
}
| メソッド名 | 説明 | 戻り値 |
| toString | オブジェクトの文字列表現を返します。 | |
| isValid | @@が有効である場合は true を返します、それ以外は false を返します。 | 有効な場合は true、それ以外は false |
| validate | @@を検証します。 | |
| is | @@を判定します。 | |
| set | @@を設定します。 | |
| get | @@を取得します。 | |
| get | @@を返します。 |