JavaDoc記述ルール完全ガイド
@param・@return・@throwsからHTML使用ルールまで

/**
 * 概要文（1文目）。ここは生成された一覧ページのサマリーに使われる。
 *
 * <p>本文。概要文の後は空行を1つ入れて本文に続ける。
 * 補足説明や使用例、注意点などをここに書く。</p>
 *
 * @param input  処理対象の入力値
 * @return 変換後の結果
 * @throws IllegalArgumentException input が null の場合
 */
public String convert(String input) {
    ...
}

/**
 * 全角・半角混在の文字列を正規化するユーティリティ。
 *
 * <p>すべてのメソッドはスレッドセーフであり、内部状態を保持しない。
 * 変換ルールは {@link NormalizeOptions} で指定する。</p>
 *
 * <pre>{@code
 * String result = TextNormalizer.normalize("ＡＢＣ１２３", NormalizeOptions.DEFAULT);
 * }</pre>
 *
 * @since 1.2
 * @author acropolis
 */
public final class TextNormalizer {
    private TextNormalizer() {}

    public static String normalize(String input, NormalizeOptions options) {
        ...
    }
}

/**
 * 指定したユーザーIDに紐づくアクティブな注文一覧を取得する。
 *
 * <p>キャンセル済み・完了済みの注文は結果に含まれない。
 * 該当する注文が1件も無い場合は空リストを返し、{@code null} は返さない。</p>
 *
 * @param userId  検索対象のユーザーID。0以下は無効
 * @param limit   取得件数の上限。0を指定すると上限なしとみなす
 * @return アクティブな注文のリスト（新しい順）。空の場合は空リスト
 * @throws IllegalArgumentException userId が0以下の場合
 * @throws OrderRepositoryException リポジトリへの問い合わせに失敗した場合
 */
public List<Order> findActiveOrders(long userId, int limit) {
    ...
}

/** デフォルトのリクエストタイムアウト（ミリ秒）。 */
public static final int DEFAULT_TIMEOUT_MS = 5000;

/**
 * 再試行の最大回数。
 *
 * <p>0を指定すると再試行を行わない。負数は指定不可。</p>
 */
private int maxRetryCount = 3;

/**
 * ユーザー情報を取得する。
 *
 * @param id ユーザーID
 * @return ユーザー情報
 * @deprecated バージョン2.0で {@link #findById(long)} に置き換えられた。
 *             次回のメジャーバージョンで削除予定。
 */
@Deprecated(since = "2.0", forRemoval = true)
public User getUser(long id) {
    ...
}

/**
 * ユーザーを取得するメソッド
 * @param id id
 * @return ユーザー
 */
public User getUser(int id) {
    ...
}

/**
 * ユーザーIDに対応するユーザー情報を取得する。
 *
 * @param id  検索対象のユーザーID。1以上の正の整数
 * @return 該当するユーザー情報
 * @throws UserNotFoundException id に対応するユーザーが存在しない場合
 */
public User getUser(int id) {
    ...
}

# HTML構文エラーや未記載の @param/@return などを警告として検出
javac -Xdoclint:all -d out src/main/java/com/example/**/*.java

# 特定カテゴリだけチェックする場合
javac -Xdoclint:missing,html -d out src/main/java/com/example/**/*.java

<module name="JavadocMethod">
    <property name="scope" value="public"/>
    <property name="allowMissingParamTags" value="false"/>
    <property name="allowMissingReturnTag" value="false"/>
</module>
<module name="JavadocType">
    <property name="scope" value="public"/>
</module>
<module name="MissingJavadocMethod">
    <property name="scope" value="public"/>
</module>