#author("2021-07-31T14:46:29+09:00","","")
#author("2021-07-31T14:48:49+09:00","","")
[[ソフトウェア開発>SoftwareEngineering]] / [[Java>../]] / [[Javadoc>./]]

* Javadoc [#a5491794]
ここでは Javadoc に記載するコメントの例を示します。

#contents

** constructor メソッドの説明 [#n3cb7911]
*** 新しい Class オブジェクトを構築します。 [#t1ddc99b]
constructor でなにもしないケース
#highlightjs([java])
 /**
  * 新しい {@code Class} オブジェクトを構築します。
  */
 public Class() {
     super();
 }

*** 初期化された新しい Class オブジェクトを構築します。 [#g37220ae]
constructor で初期値を設定するケース
#highlightjs([java])
 /**
  * 初期化された新しい {@code Class} オブジェクトを構築します。
  */
 public Class() {
     super();
     fieldName = value;
 }

*** 指定された param1 を持つ、新しい Class オブジェクトを構築します。 [#w8d65924]
#highlightjs([java])
 /**
  * 指定された {@code param1} を持つ、新しい {@code Class} オブジェクトを構築します。
  * 
  * @param param1
  */
 public Class(final String param1) {
     super();
     this.param1 = param1;
 }

*** 指定された param1 と param2 を持つ、新しい Class オブジェクトを構築します。 [#m0f29948]
#highlightjs([java])
 /**
  * 指定された {@code param1} と {@code param2} を持つ、新しい {@code Class} オブジェクトを構築します。
  * 
  * @param param1
  * @param param2
  */
 public Class(final String param1, final String param2) {
     super();
     this.param1 = param1;
     this.param2 = param2;
 }

** その他のメソッドの説明 [#kdf8d3a1]
|メソッド名|説明|戻り値|h
|toString|オブジェクトの文字列表現を返します。|このオブジェクトの文字列表現|
|isValid|@@が有効である場合は true を返します、それ以外は false を返します。|有効な場合は true、それ以外は false|
|isValid|@@が有効である場合は {@code true} を返します、それ以外は {@code false} を返します。|有効な場合は {@code true}、それ以外は {@code false}|
|validate|@@を検証します。||
|is|@@を判定します。||
|set|@@を設定します。||
|get|@@を取得します。||
|get|@@を返します。||

トップ   差分 履歴 リロード   一覧 検索 最終更新   ヘルプ   最終更新のRSS