#contents

*EclipseでjavaDoc
普通にjavaのソースにjavadocコメントを書いただけでは、概要ページがのっぺらぼうのjavadocが生成されます。~
なので、概要ページに記述されるべき物の設定やらの覚書~
各クラス・メソッドにはjavaDocコメントが記述されているのが前提~

**概要の説明ファイル作る
-APIの概要ページの先頭に記述されるメッセージを作成します。
***overview.htmlファイルを作成する
-overview.htmlファイルを作成します。((ただのhtmlです))
-中身に以下のように記述します。
 <html>
 <head>
 </head>
 <body>
 このドキュメントはアプリケーション「test」のAPI仕様です.<br>
 「test」はなんでもありのサーブレット実験用アプリケーションです.
 </body>
 </html>
>Bodyの1行目が概要になります。2行目からは説明
-このファイルをソースのrootディレクトリに置きます
--Eclipseで素直にプロジェクトを作っている場合「src」配下



**各パッケージの説明ファイルを作る
-APIの概要ページにて表示される各パッケージの説明を作成します。
***package.htmlファイルを作成する
-package.htmlファイルを作成します。((やっぱりただのhtmlです))
-中身に以下のように記述します。
 <html>
 <head>
 </head>
 <body>
 各種テストクラスを提供します
 </body>
 </html>
>Bodyに説明を記述します。
-このファイルを各パッケージ配下に置きます。するとそのHTMLがそのパッケージの説明になります。
-各パッケージに同じようにpackage.html置いていきます。



**EclipseでjavaDoc生成
-[プロジェクト]→[javadoc の生成]選択

***javaDoc生成ウィザードの設定

-次のウィンドウでjavadocを生成したいプロジェクトを選択します
#ref(javadoc01.jpg)
-次へ進みます

-次のウィンドウで[文書タイトル]にチェックを入れタイトルを記入します。
--このタイトルは概要ページの先頭にあるタイトルのことです。((j2seだったら「JavaTM 2 Platform,  Standard Edition, 1.4.0 API 仕様」とか書いてるやつです))
#ref(javadoc02.jpg)
-次へ進みます

-次のウィンドウで[概説]にチェックを入れ[ブラウズ]から概要の説明ファイルoverview.htmlにパスを通します。
#ref(javadoc03.jpg)
-終了でjavadocを生成します。
--javadoc1.4では[-quiet]なんてパラメータを付加してやると生成時のコンソールのコメントがErrorのみになります。((正常に生成されてるのにコメントはかれるのはうざいのでおすすめ)) 



***生成されたjavadocはこんな感じ

-するとこんな感じで概要のページが生成されます。
#ref(javadoc04.jpg)
-なんとなくそれらしくなったかと思います。

~
~

*情報
-クラスに禁則文字を使っているとjavaDocの生成対象から外れるそうです。 -- [[javadoc1.4]] SIZE(10){2003-10-29 (水) 22:16:00}
-[overview.html]のファイル名はjavadoc生成時にpathを通すのでぶっちゃけどんなファイル名でも良いと思うのですが、標準的に[overview.html]にするようです。 -- [[概要]] SIZE(10){2003-10-29 (水) 22:22:40}
#comment


*備考
参考
-[[javadoc ・Java API ドキュメントジェネレータ:http://java.sun.com/j2se/1.4/ja/docs/ja/tooldocs/win32/javadoc.html]]

トップ   新規 一覧 単語検索 最終更新   ヘルプ   最終更新のRSS