Javadoc

Javadocコメントとは「/**」と「*/」でくくるコメントのことでした。

Javadocコメントの中で主に使用するのは以下の 4つです。

• @args 引数…引数の説明
• @throws 例外…例外の説明
• @return…戻り値の説明

Javadocコメントを HTMLファイルとして出力することができます。手順は以下の通り。

まずは、出力したいプロジェクトを選択します。今回は D302プロジェクトを選択しました。

続いて、メニューバーから、Project→ Generate Javadocを選択します。

新しいウインドウが表示されます。

ここでは、3点を設定する必要があります。

• Javadoc command…「Configure」ボタンを押し、パソコンのどこかに入っている JDKディレクトリの binディレクトリの中にある javadocを選択します。
• Create Javadoc for members with visibility…今回は「Package」を選択します。
• Use standard doclet…出力ディレクトリを指定します。新規ディレクトリを指定しましょう。

最後に「Finish」を押すと、Javadocが生成されます。その index.htmlを開くと、そのプロジェクトのクラスやメソッドの一覧を確認することができます。