ソースコードでの Javadoc コメントの生成

関連項目

エディタヒントを使用すると、ソースファイル内のコード要素に対して、基本的な Javadoc コメントを自動的に生成できます。生成されたコメントには、特定のコード要素に必要なタグが組み込まれます。たとえば、メソッドがパラメータを取る場合、@param タグが挿入されます。また、コメントに不正なタグが含まれているような場合に、ヒントを使用して Javadoc コメントの修正内容を生成することもできます。

エディタヒントが存在する場合は、ソースエディタの左マージンに電球アイコンが表示されます。このヒントを参照するには、電球アイコンをクリックするか、Alt-Enter キーを押します。ヒントに提示されたコードを生成するには、ヒントをクリックするか、Enter キーを押します。

デフォルトでは、Javadoc の生成に対するヒントはオフになっています。

Javadoc コメントのヒントをオンにする

  1. 「ツール」>「オプション」を選択します。
  2. 「オプション」ウィンドウの上部にある「Java コード」ボタンをクリックします。
  3. 「ヒント」タブをクリックします。
  4. 「Javadoc」チェックボックスを選択します。

デフォルトでは、Javadoc のヒントは限定公開要素と公開要素に対して機能します。ヒントの有効範囲を変更する場合は、Javadoc ノードを展開し、サブノードのいずれかを選択します。次に、ヒントを適用する範囲のラジオボタンを選択します。

Javadoc タグの詳細については、次の場所を参照してください。

Javadoc コメントを記述する方法については、次の場所を参照してください。

関連項目
Javadoc ドキュメントの生成
プロジェクトへの Javadoc の追加

著作権と商標について