Print Friendly, PDF & Email

1.Javadocとは

Javadocとは、JavaのソースコードからHTML形式のAPI仕様書を生成するものです。
Javadocは以下のようなJavaクラスの仕様書の標準の書式です。

例えば、皆さんおなじみのJavaのAPIもJavadocで書かれています。
Javaの技術者の共通理解がありますので、この形式でドキュメントを残すと非常にわかりやすいです。

2.Javadoc用のコメント

Javadoc用のコメントは、以下のように書きます。

/**
* Javadoc用のコメントです。
*/

「@」を使い、以下のような特殊な意味を持たせることが可能です。

@author:作成者
@version:バージョン指定
@param:パラメータに関する説明
@return:戻り値に関する説明
@throws(@exception):発生する可能性のある例外に関する説明
@deprecated:クラスやメソッドなどを「非推奨」として指定

3.Javadocを生成するJavaのソースコードの例

package netbeans;

/**
 * Javadocのテストプログラム
 *
 * @author Yusei Yamazaki
 * @version 1.0.0
 */

public class JavaDocTest {

    /**
     * squareRootメソッド 引数の平方根を返す
     *
     * @param num 整数値
     * @return 引数の平方根
     */
    public static double squareRoot(int num) {
        // 引数平方根を返す
        return Math.sqrt(num);
    }

    /**
     * mainメソッド squareRootメソッドに引数を渡して結果を出力する
     */
    public static void main(String[] args) {
        // answerにsquareRootメソッドの結果を代入
        double answer = squareRoot(3);
        // 結果を出力
        System.out.println(answer);
    }
}

NetBeansを使いJavadocを生成するには、プロジェクト・エクスプローラーでプロジェクトを右クリックして、「javadocの生成」を選択するだけです。

生成されたJavadocを後から見るには、ソースコードの中でパッケージ名やクラス名、メソッド名を選択した状態で右クリックしてコンテキストメニューを表示、「Javadocを表示」を選ぶとブラウザに表示されます。

なお、JSPはJavadocにはなりません。

NetBeans IDEの説明に戻る