ドキュメント・コメントの監査

ソース・ファイルに記載されているドキュメント・コメントを簡単に検証できます。監査を実施すると、書式設定エラー、欠落しているタグまたは余分なタグが報告されます。

ソース・ファイルのドキュメント・コメントをチェックするには、次のようにします。

  1. アプリケーション・ナビゲータで、チェックするファイルを選択します。

  2. メイン・メニューから、「実行」次の選択<filename>のコード監査」を選択します。

  3. 「コード監査」ダイアログで、「プロファイル」ドロップダウン・リストからJavadocルールを選択します。

  4. 検索または無視するエラーのタイプを選択できるようにコード監査を設定する場合には、「編集」をクリックします。

    「コード監査プロファイル」ダイアログが開きます。詳細は、「ヘルプ」をクリックしてください。

  5. 「実行」をクリックします。

    コード監査の結果は、ログ・ウィンドウに表示されます。


ドキュメント・コメントの追加
ドキュメント・コメントの更新
ドキュメント・コメントのプレビュー
Javadocコード・エディタの設定
プロジェクトのJavadocプロパティの設定
Javadocの実行
Javaコードの監査