Javadocとは : JavaA2Z

Javadoc

日本語	ジャバ文書
英語	java document
ふりがな	じゃばどっく
フリガナ	ジャバドック

プログラムに書かれたコメントからドキュメントを作成するためのツール。
J2SEに付属するツールのひとつ。
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ディレクトリに出力します。

*/

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

Javadoc

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

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

users

update:2005/07/23

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