ソースコードでの Javadoc コメントの入力
関連項目
自動コメントツールを使用して、ドキュメント化されていない任意のコード要素に対して自動的に Javadoc コメントを入力できます。自動コメントツールは、次の項目について判別します。
- ドキュメント化する必要があるすべての Java 要素に Javadoc コメントがあるかどうか。
- 既存のコメントが属する要素に対応しているかどうか。たとえば、メソッド内の各パラメータは、@param タグを持ち、メソッドから生成された各例外は @throws タグを持っている必要があります。
Javadoc コメントに関するソースコードのチェックを行う
- 「プロジェクト」または「ファイル」ウィンドウで、確認するファイルを右クリックし、「ツール」>「自動コメント」を選択します。
- 左区画のリストからタグエラーの修正または存在しないタグの生成を行うメソッドを選択します。「フィルタ」ツールバーボタンを使用して、表示するクラスとメンバーを制御できます。
アイコンは、有効な Javadoc コメントを示し、
は、不完全なまたは正しくないコメントを示し、
は、コメントがないことを示します。
- 「自動修正」をクリックします。
- コメントが必要な場合は、IDE が存在しないタグを生成し、「自動コメントツール」タブの「タグ」区画、およびソースファイル内のメソッドの直前の行に表示します。
- コメントが断片的であったり不完全な場合は、「自動コメントツール」タブの「詳細」区画にコメントを訂正する方法についての情報が表示されます。
- その他の必要な編集を行います。コメントが正しい場合は、「詳細」区画に「Javadoc コメント問題なし」と表示されます。
- 完了したら、「編集」ウィンドウのタブを閉じて、自動コメントツールを終了します。
Javadoc タグの詳細については、次の場所を参照してください。
Javadoc コメントを記述する方法については、次の場所を参照してください。
- 関連項目
- Javadoc ドキュメントの生成
- プロジェクトへの Javadoc の追加
著作権と商標について