Tweet

EclipseでJavadocを利用するには 山田祥寛 2003/9/5

■Javadocを利用してAPIリファレンスを作成する

　本来コマンドラインから利用するJavadocをEclipseから対話ベースで利用することができます。また、Javadocコメントと呼ばれる一種独特のコメントを記述する場合にも、Eclipseのコメント自動生成機能を用いることで作業をシンプル化することができます。

■操作手順

（1）Javadocコメントを追加する

　エディタ上でJavadocコメントを自動生成したいクラス、またはメソッドのコード部分にカーソルを置きます。右クリックし、表示されたコンテキストメニューから［ソース］→［Javadocコメントの追加］を選択します。

105行目を選択したところ

　すると、メソッドに対応したJavadocコメントが自動生成されます。あとは、これに対してメソッド／引数／戻り値の説明などを追加するだけです。

選択したコードの上にコメントが追加される

（2）JavadocコメントからAPIリファレンスを作成する

　ソースコードが完成したら、プロジェクト内の「.java」ファイルから実際にドキュメントを作成してみましょう。メニューバーから［プロジェクト］→［Javadocの生成］を選択すると、Javadoc生成ウィザードが起動します。

Javadoc生成ウィザード

　設定項目は多岐にわたりますが、下表にウィザードの各ページにおける主要な項目をまとめました。

　コンソールに生成過程が表示され、終了のメッセージが表示されれば成功です。

コンソールに生成過程が表示される

　ウィザードで［生成された索引ファイルをブラウザで開く］にチェックを入れた場合、生成されたドキュメントがEclipseから自動的に呼び出されます。

生成されたドキュメント

（3）外部のJavadocを呼び出す

　生成されたJavadocは「パッケージ・エクスプローラ」から参照することも可能です。パッケージ・エクスプローラ上の該当クラスを選択した状態で、メニューバーの［ナビゲート］→［外部Javadocを開く］を選択してください。

　もしも正常に関連づけがされていない場合には、「パッケージ・エクスプローラ」から該当のプロジェクト名を選択し、右クリック、表示されたコンテキストメニューから「プロパティ」を選択してください。「<プロジェクト名>のプロパティ」が開きますので、左ツリーからJavadocロケーションを選択し、Javadocが格納されたルートのフォルダパスを指定します。

他のJavadocが格納されたフォルダパスを指定する

「Java TIPS」

＠ITメールマガジン　新着情報やスタッフのコラムがメールで届きます（無料）

RSSフィード