ページの本文へ

Hitachi

ソフトウェアミドルウェア

EclipseからJavadocを生成するには?

作成したJavaソースのAPIリファレンスを生成するには、Javadocというツールを使います。
JavadocはJDKに同梱されており、APIリファレンスを生成したいJavaソースをコマンドライン引数として与えて実行すれば、簡単に生成できます。

例えば、test.javaというJavaソースのAPIリファレンスを生成する場合は、コマンドプロンプトから

 <JDKインストールディレクトリ>\bin\javadoc.exe test.java

のように実行します。

EclipseでJava開発をしている場合

Eclipse上で開発したJavaソースのAPIリファレンスを生成するときもコマンドプロンプトからjavadoc.exeを実行するの?

と思ったことはないでしょうか?

実は、コマンドプロンプトを開かなくても、EclipseからJava API リファレンスを生成することができます。

具体的には、Eclipseのエクスポートダイアログを使います。

(1)
Eclipseメニューから「ファイル」>「エクスポート」を選択し、「Java」>「Javadoc」を選択します。

「エクスポート」ダイアログ

(2)
次のページへすすみ、

  • Javadocコマンドのロケーション
  • APIリファレンスの生成対象とするJavaソース
  • APIリファレンスの出力先

などを指定します。

「Javadocの生成」画面

指定したら、「終了」ボタンを選択しましょう。
これで、APIリファレンスの生成が完了です。

APIリファレンスの出力先として、現在作業中のJavaプロジェクト内を指定すると、Eclipseの「パッケージ・エクスプローラー」ビューなどで多くのファイルが生成されていることが、すぐに確認できますね。

ファイル生成後の「パッケージ・エクスプローラー」ビュー

index.htmlをダブルクリックすると、作成したJavaソースのAPIリファレンスの内容が確認できます。

チーム開発で他のメンバーが作ったAPIを使用するときに、APIリファレンスがあるとコーディングがしやすくなるので、Javadocを生成しておくことはとても重要です。
ぜひこの機能を活用してください。

なお、Javadocにパスを通しておくと、エディター内で[Shift] + [F2]とすることで、すぐにJavadocを参照することができます。
パスの通し方の詳細はEclipseでAPIリファレンスをすばやく参照するには?その3をご覧ください。