ドキュメンテーションコメントとは : JavaA2Z

ドキュメンテーションコメント

日本語	文書注釈
英語	documentation comment
ふりがな	どきゅめんてーしょんこめんと
フリガナ	ドキュメンテーションコメント

Javadocで出力するためのコメント。
クラス、メソッド、フィールドの直前にある「/**」から始まるコメント。
このコメント中に書かれた文章はJavadocによってHTML ファイル化することでクラス、メソッド、フィールドの「仕様書」の文章とすることができる。
また、「@」から始まるタグを使用することで、さらに詳細な情報を記述することができる。

参考サイト

javadoc - The Java API Documentation Generator

(KAB-studioからのおしらせです)

// Sample.java

/**
*   サンプルクラスです。
*/
public class Sample
{
    /**
    *   main()メソッド。<br>
    *   最初に呼ばれるメソッドです。
    *   @param args javaコマンド実行時に渡されるパラメーターが入っています。
    */
    public static void main( String[] args )
    {
        int result = toInt( "100" );
        System.out.println( result );
        // 100
    }

    /**
    *   整数値に変換します。
    *   @return 変換後の整数値。
    *   @param string 変換前の文字列。"100"とか。
    */
    public static int toInt( String string )
    {
        return Integer.parseInt( string );
    }
}

/*
あとは、javadocコマンドで出力します。

>javadoc -d html src/*.java

この例では、srcディレクトリ内のソースファイルのドキュメントを
htmlディレクトリに出力します。

*/

// Sample.java

/**
*   サンプルクラスです。
*/
public class Sample
{
    /**
    *   main()メソッド。<br>
    *   最初に呼ばれるメソッドです。
    *   @param args javaコマンド実行時に渡されるパラメーターが入っています。
    */
    public static void main( String[] args )
    {
        int result = toInt( "100" );
        System.out.println( result );
        // 100
    }

    /**
    *   整数値に変換します。
    *   @return 変換後の整数値。
    *   @param string 変換前の文字列。"100"とか。
    */
    public static int toInt( String string )
    {
        return Integer.parseInt( string );
    }
}

/*
あとは、javadocコマンドで出力します。

>javadoc -d html src/*.java

この例では、srcディレクトリ内のソースファイルのドキュメントを
htmlディレクトリに出力します。

*/

「みだし」に含まれているページ

ドキュメンテーションコメント

「解説」に含まれているページ

「サンプルプログラムとか」に含まれているページ

users

update:2005/07/23

このページは、Javaプログラミング言語についての用語を網羅した辞書「JavaA2Z」の一ページです。
詳しくは「JavaA2Z」表紙の説明をご覧ください。