Java コンパイラーの Javadoc 設定

Javadoc の設定値は 「Javadoc」設定ページを開く 「Java」>「コンパイラー」>「Javadoc」設定ページで指定します。

オプション

説明

デフォルト

Javadoc コメントを処理 (検索およびリファクタリングを含む)

このオプションが使用可能になっていると、ビルダーは Javadoc コメントで問題を検出します。 検索およびリファクタリングが Javadoc コメントで動作するには、このオプションも使用可能にする必要があります。

オン

誤った形式の Javadoc コメント

使用可能にすると、コンパイラーは、誤った形式の Javadoc コメントを検出した場合にエラーまたは警告を出します。

無視

メンバーの可視性を次のように設定

コンパイラーは、指定した可視性またはそれより広い可視性を持つメンバーだけをチェックします。

public

タグ引数 (@param、@throws、@exception、@see、@link) を検証

使用可能にすると、コンパイラーは、Javadoc コメントのタグ引数 (@param、@throws、@exception、@see、@link) でエラーを検出した場合にエラーまたは警告を出します。

オフ

不可視参照をレポート

使用可能にすると、コンパイラーは、不可視要素への参照を検出した場合にエラーまたは警告を出します。

オフ

使用すべきではない参照をレポート

使用可能にすると、コンパイラーは、使用すべきではない要素への参照を検出した場合にエラーまたは警告を出します。

オフ

タグ記述が欠落しています

「すべての標準タグを検証」、「@return タグを検証」および「無視」から選択します。使用可能にすると、コンパイラーは、欠落したタグ記述を検出した場合にエラーまたは警告を出します。

「@return タグを検証」

未指定の Javadoc タグ

使用可能にすると、コンパイラーは、未指定の Javadoc タグ (例えば、パラメーターに対して未指定の @param タグ) を検出した場合にエラーまたは警告を出します。

無視

メンバーの可視性を次のように設定

コンパイラーは、指定した可視性またはそれより広い可視性を持つメンバーだけをチェックします。

public

オーバーライドおよび実装メソッドを無視

使用可能にすると、別のメソッドをオーバーライドまたは実装するメソッドは、未指定の Javadoc タグについて検査されません。

オン

メソッド型パラメーターを無視

使用可能にすると、メソッド型パラメーターに関する未指定の Javadoc タグは報告されません。

オン

未指定の Javadoc コメント

使用可能にすると、コンパイラーは、Java メンバーに対する未指定の Javadoc コメントを検出した場合にエラーまたは警告を出します。

無視

メンバーの可視性を次のように設定

コンパイラーは、指定した可視性またはそれより広い可視性を持つメンバーだけをチェックします。

public

オーバーライドおよび実装メソッドを無視

使用可能にすると、別のメソッドをオーバーライドまたは実装するメソッドは、未指定の Javadoc コメントについて検査されません。

オン