JavaA2Z

KAB-studio > プログラミング > JavaA2Z > javadocとは

javadoc

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

解説

プログラムに書かれたコメントからドキュメントを作成するためのツール。
J2SEに付属するツールのひとつ、Javadocのコマンド。
コンソールからjavadocコマンドを実することで、プログラムドキュメンテーションコメントを元に、仕様書が記述されたHTMLファイルを作成する。

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

サンプルプログラム(とか)サンプルを別ウィンドウで表示サンプルをクリップボードへコピー(WindowsでIEの場合のみ)

// 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ディレクトリに出力します。

*/

この単語を含むページ

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

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

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

はてなブックマーク 詳細を表示 はてなブックマーク ブックマーク数
livedoorクリップ 詳細を表示 livedoorクリップ ブックマーク数
Yahoo!ブックマーク 詳細を表示 users
del.icio.us 登録する RSSに登録
サンプルを別ウィンドウで表示
サンプルをクリップボードへコピー(WindowsでIEの場合のみ)
update:2005/07/23
このページは、Javaプログラミング言語についての用語を網羅した辞書「JavaA2Z」の一ページです。
詳しくは「JavaA2Z」表紙の説明をご覧ください。