作成のJavadoc


作成のJavadoc

それは何ですか?


Javadocはhtmlコードのドキュメントを生成するための標準化されたコードのドキュメントです。

公式ドキュメントには、OracleのWebサイト上にある:http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html

どのように生成するには?


以下の例では、最小攻撃可能なJavadocのために何を書くことを示しています。

Javaプログラムでは、Javadocが囲まれて/ ** * /

すべての機会が十分に単純に滞在するために対処されていません。

/ ***例のJavadocの例を定義するクラスであります*このクラスは、以下のことを特徴としています。*
    *
  • 属性1の機能説明
  • *
  • 属性2の機能説明
  • *
*クラスの主な機能の説明*

*追加の説明、静的属性など*

著者の* @author名* @versionバージョン番号* /パブリッククラスの例{/ ***属性1の説明* /プライベート文字列attribute1と、/ ***属性2の説明* /プライベートint型attribute2の。/ *** メーカーの例**任意の追加情報。メーカーで*例えば使用する親。** @param attribute1の*属性1の説明* @param attribute2の*属性2の説明* /例えばパブリック(文字列attribute1の、attribute2のINT){this.attribut1 = attribute1の。this.attribut2 = attribute2の。}/ ***この方法の有用性の説明* @paramのEX*入力パラメータの説明出力の* @returnの説明* @throws InterruptedExceptionあります*例外の伝播の理由の説明* /公共int型methodeExemple(例えば文字列)例外:InterruptedExceptionをスロー{0を返します。}}

輸出のJavadoc


Javadocをエクスポートするには、我々は、エクスポートするプロジェクトまたはクラス上で右クリックを行い、[エクスポート]をクリックします。

その後、実行するのJavadocコマンドについて先フォルダや情報を選択してください。これは、JDKにあるjavadoc.exeプログラムへのパスです。

最後にエクスポート]をクリックします。


ログが表示されます。


すべてのクラスの建物のインデックス...
生成D:\のdoc \のallClasses-frame.html ...
生成D:allClasses-noframe.html \ \ドキュメント...
生成D:\のdocの\ index.htmlを...
生成D:\のdoc \のも、help-doc.html ...
生成D:\のdocの\ stylesheet.css ...

そして、Javadocは指定したフォルダにあります。
D:\ Uploadedfiles \ yql730WW35sIkNuIkMb5pMy_ZjOKOTNyoIdBaKD_YEiS8_Iのdoc \のexample.html \ - スキップnavbar_top
作成のJavadocこの記事(PDF)をダウンロード cs_Julien39投稿者。 」と題されたこの文書 からのJavadoc»を作成しますコード・ソース (Codes-sources.commentcamarche.net)クリエイティブ・コモンズのライセンスの下で利用できるようになります。あなたはライセンスの定める条件の下で、このページのコピーを変更、コピーすることができ、このノートとして明確に表示されます。この記事をダウンロードする(PDF