【Java】Javadocってなに？

プログラミング勉強日記

2020年11月22日
授業でJavadocを元にコードを書いたことはあるが、Javadocについて理解できていないのでまとめる。

Javadocとは

　JavaではJavadocというコメントを記述することができ、プログラムについて説明するドキュメントをソースコードに埋め込むためのものである。プログラムの説明をソースコードに埋め込むことができない場合、プログラムの説明文は別のファイルで管理することになり、コード用のファイルと説明ファイルの両方の管理が必要になる。しかし、この場合は修正時にドキュメントの更新を忘れてしまい、説明と動作が一致しないということが起きる可能性がある。Javadocをうまく使うことで、コードの修正時にドキュメントの修正もできる。
　Javadocはクラスの概要やメソッドの概要を記述しておくと、その情報からHTML形式のドキュメントファイルを生成してくれる。

　Javadocコメントを書く場合は/**と*/の間にコメントを記述する。

Javadocコメント

/**
Javadocコメント
*/

サンプルコード

/**
 * @author Tanaka Taro
 * @version 1.0.0
 */
 
 /**
  * Javadoc解説用のメインクラス
  */
public class Main {
    /**
     * mainメソッド
     * @param args 使用しない
     */
    public static void main(String[] args) {
        System.out.println("Hello World!");
    }
}

Javadocのタグ名

　Javadocには@がついたタグが用意されている。

タグ名	説明
@author	クラスの作成者
@version	作成したプログラムのバージョン
@param	メソッドの引数の説明
@return	メソッドの返り値の説明
@throw	発生する例外クラスを指定
@serial	直列化されたフィールドの説明
@sesrialData	直列化された状態でのデータ型と順序
@since	初めて作ったときのバージョン

参考文献

いまさら聞けない「Javadoc」と「アノテーション」入門 (1/4)
【Java入門】コメントの種類と書き方(Javadocに関する規約も解説
Javadocタグ