ドキュメンテーションコメント文の書き方

Javaにおけるドキュメンテーションコメント文の書き方。

ドキュメンテーションコメント文を含むソースコードを、javadocコマンドで処理すると、クラスやメソッドなどの仕様を記したHTML形式のドキュメントを生成する。

記述形式

クラスやメソッドなどの説明文を、/**と*/で括り、クラスやメソッドなどの宣言の直前に記載する。

記述例

/**
 * このクラスは、「Hello World !」を出力します。
 */
public class HelloWorld {
    // ～
}

サンプル

ソースコード

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コマンドで処理すると、HelloWorldクラスの仕様を記したHTML形式のドキュメントを生成する。

Eclipseでjavadoc処理する方法については、こちら。