Eclipseでjavadoc処理

Eclipseでjavadoc処理し、クラスやメソッドなどの仕様を記したHTML形式のドキュメントを生成する方法。

Javaプロジェクトと「HelloWorld.java」ファイルを作る

Eclipseで「Hello World !」プログラムのページを参考にしながら、「SampleProject」というプロジェクトを作り、「HelloWorld.java」ファイルを作る。

「HelloWorld.java」ファイルを編集

「HelloWorld.java」ファイルの内容を、下記のように編集する。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
package samplePackage;

/**
 * Class to output "Hello World!"
 */
public class HelloWorld {

    public static void main( String[] args ){

        String $string = "Hello World !";

        if( $string != null ) {
            System.out.println( $string );
        }
    }

}

下記の箇所が、ドキュメンテーションコメント文であり、javadoc処理でクラスなどの仕様書を生成するときに使われる。
ドキュメンテーションコメント文の書き方については、こちら。

1
2
3
/**
 * Class to output "Hello World!"
 */

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

Eclipse-SampleProject-Export 「パックケージ・エクスプローラー」にある「SampleProject」の上で右クリックメニューを開き、「エクスポート」をクリックし、「エクスポート」ダイアログを開く。

Eclipse-ExportDialog-Javadoc 「Java」フォルダの中の「javadoc」をダブルクリックし、「javadoc 生成」ダイアログを開く。

「javadoc 生成」ダイアログ

Eclipse-JavadocDialog-SampleProject 「SampleProject」にチェックを入れ、「完了」ボタンをクリックする。

クラスやメソッドなどの仕様を記したHTML形式のドキュメント

Eclipse-SampleProject-docFolder 右の画像にあるようなファイルを、「doc」フォルダ内に生成する。

Eclipse-SampleProject-doc-index 右の画像は、「index.html」ファイルをブラウザで表示したところ。