JavaDocを書く

JavaDocとは

JavaDocは、Javaソースコード中のコメントから自動的にHTML形式のドキュメントを生成するツールです。/** ... */の形式で、クラス・メソッド・フィールドの説明を書くことができます。

EclipseでJavaDocを書く方法

1. JavaDocコメントの入力

Eclipseでは、クラスやメソッドの上で /** と入力して Enter を押すと、JavaDocのテンプレートが自動的に挿入されます。

/**
 * このクラスはユーザー情報を管理します。
 */
public class User {
    /**
     * ユーザー名
     */
    private String name;

    /**
     * ユーザー名を取得します。
     * @return ユーザー名
     */
    public String getName() {
        return name;
    }

    /**
     * ユーザー名を設定します。
     * @param name 設定するユーザー名
     */
    public void setName(String name) {
        this.name = name;
    }
}

JavaDocのHTML出力（Eclipse上での手順）

1. メニューで プロジェクト → Javadocの生成... を選択
2. 「Javadoc コマンド」に javadoc.exe のパスが指定されていることを確認（例：C:\Program Files\Java\jdk-17\bin\javadoc.exe）
3. 対象とするパッケージやクラスを選択
4. 出力先フォルダを指定
5. 完了 をクリック

指定フォルダにHTML形式のJavaDocが生成されます。

EclipseでのJavaDocの表示

• メソッドやクラス名にマウスを当てると、JavaDocの内容がポップアップで表示されます。
• JDKやライブラリにJavaDocが含まれていれば、そちらの内容も同様に表示されます。

よく使うJavaDocタグ

Eclipseの使い方に戻る

IT企業向け新人研修おすすめ資料　無料公開中 (saycon.co.jp)