Javadocについて

dorako321

9年前

javadocとは、クラス、メソッドの説明時に使用するドキュメンテーションコメントのことで、以下のような記述を行います。クラスやメソッド、引数、戻り値の説明を記入します。

/** ほげほげするクラス
 *  @version 1.0.0
 */
public class Hogehoge {
  /** ほげほげするメソッド
   *
   */
  public boolean GetHogehoge(String hoge){
    return true;
  }
}

/** ほげほげするクラス

* @version 1.0.0

public class Hogehoge {

/** ほげほげするメソッド

public boolean GetHogehoge(String hoge){

return true;

}

そのほかにはインプリテーションコメントがあり、通常使用している

//コメント
 
/* コメント*/

//コメント

/* コメント*/

の事を指します。ドキュメンテーションコメントはプログラムからドキュメントを生成する場合に使用するため、インプリテーションコメントは使い分ける必要があります。（Eclipse環境などでドキュメンテーションコメントとインプリテーションコメントの文字色が異なるのはこのためです。）

javadoc内ではコメント内に意味をタグ付けするための記法があります。

@タグ 内容

@タグ内容

という単純な記法です。タグは以下の種類があります。

@author クラスの作成者情報を記載
@param メソッドの引数の説明
@return メソッドの返り値の説明
@throw 発生する例外クラスを指定
@see 他のAPIを参照する場合に記載
@deprecated 推奨されないAPIであることを示す
@serial 直列化されたフィールドの説明
@sesrialData 直列化された状態でのデータ型と順序を記載
@since 導入されたバージョンを記載
@version バージョンを記載

記載する場合は

*宣言するソースとインデントを合わせること
*メソッドやクラスの直前に記載すること

1 2	宣言するソースとインデントを合わせることメソッドやクラスの直前に記載すること