|
|
Javadoc テクノロジ |
ドキュメントの目次 |
Javadoc は、ソースファイルセット内の宣言およびドキュメンテーションコメントを解析し、クラス、インタフェース、コンストラクタ、メソッド、およびフィールドについて記述した HTML ページセットを生成するツールです。Javadoc のドックレットを使用して Javadoc の出力をカスタマイズできます。ドックレットとは、ドックレット API を使用して書かれたプログラムのことで、Javadoc ツールで生成するべき出力の内容と形式を指定しています。HTML、SGML、XML、RTF、MIF など、任意の種類のテキストファイル出力を生成するためのドックレットを作成できます。SunTM は、HTML 形式の API ドキュメントを生成する「標準」ドックレットと、MIF、PDF、FrameMaker、およびその他の形式を生成する実験的な MIF ドックレットを提供しています。さらに、ドックレットを使うと、API ドキュメントの生成とは関係のない特別な処理を行うこともできます。
タグレットは、-tag オプションを使用して作成されたカスタムタグより柔軟性のあるカスタムタグを作成し使用することのできるプログラムです。カスタムタグは、Javadoc タグからテキストの書式設定と表示を行うためにドックレットで使用されます。タグレットは、タグレットインタフェースを実装する必要があります。
- 「ドックレット API」 - ドックレット API を構成する com.sun.javadoc パッケージについて説明しています。
- 「インタフェースタグレット」 - タグレット API を構成する com.sun.tools.doclets.Taglet クラスについて説明しています。
このページでは、Javadoc ツールを実行するためのすべての javadoc タグとコマンド行オプションを、Solaris および Microsoft Windows で使用する場合の例とともに一覧表示します。
ドックレットの情報:
- 「ドックレットの概要」 - ドックレットの概要をドックレット API の使い方の簡単な実例とともに紹介します。
- 標準ドックレットの実行 - デフォルトの HTML 形式 の API ドキュメントを生成するドックレット。Javadoc の -doclet オプションでドックレットを何も指定しないと、この標準ドックレットが使用される
- 「5.0 ドックレット API への移行」 - 5.0 の新しい言語機能をサポートできるように従来のドックレットを拡張するためのヒント。
タグレットの情報:
- 「タグレットの概要」 - タグレットの概要をタグレット API の使い方の簡単な実例とともに紹介します。
次の JavaTM SE ドキュメントを参照してください。
次の Java Software Web サイトを参照してください。
- Javadoc FAQ - 貴重なヒントとバグの回避方法
- Javadoc Forum - 他の開発者との討論に参加できます。参加するには、Java Developer Connection に会員登録する必要があります (無料)。「Javadoc Tool」カテゴリをクリックしてください。Javadoc チームでは、このフォーラムの定期的な確認は行っていません。Javadoc チームからすぐに返信が必要な場合は、下記のフィードバック用アドレスをご利用ください。
- Javadoc メーリングリスト - 情報提供用に公開されているメーリングリストです。 このメーリングリストに登録すると、Javadoc ツール、標準ドックレット、MIF ドックレット、DocCheck ドックレット、ローカライズ版ドックレット、その他に関して公表される主な情報を受け取ることができます。メールサイズはあまり大きくありません。
|
Copyright © 2006 Sun Microsystems, Inc. All Rights Reserved. フィードバック |
|