Javadoc テクノロジ
Javadoc のドックレットを使用して Javadoc の出力をカスタマイズできます。ドックレットとは、ドックレット API を使用して書かれたプログラムのことで、Javadoc ツールで生成するべき出力の内容と形式を指定しています。HTML、SGML、XML、RTF、MIF など、任意の種類のテキストファイル出力を生成するためのドックレットを作成できます。Sun™ は、HTML 形式の API ドキュメントを生成する「標準」ドックレットと、MIF、PDF、FrameMaker、およびその他の形式を生成する実験的な MIF ドックレットを提供しています。さらに、ドックレットを使うと、API ドキュメントの生成とは関係のない特別な処理を行うこともできます。
タグレットは、-tag オプションを使用して作成されたカスタムタグより柔軟性のあるカスタムタグを作成し使用することのできるプログラムです。カスタムタグは、Javadoc タグからテキストの書式設定と表示を行うためにドックレットで使用されます。タグレットは、タグレットインタフェースを実装する必要があります。
API の仕様
- ドックレット API - ドックレット API を構成する com.sun.javadoc パッケージについて説明しています。
- タグレット API - タグレット API を構成する com.sun.tools.doclets.Taglet クラスについて説明しています。
ツール
このページでは、Javadoc ツールを実行するためのすべての javadoc タグとコマンド行オプションを、Solaris および Microsoft Windows で使用する場合の例とともに一覧表示します。チュートリアルおよびプログラマーズガイド
ドックレットの情報:- ドックレットの概要 - ドックレットの概要をドックレット API の使い方の簡単な実例とともに紹介します。
- 標準ドックレットの実行 - デフォルトの HTML 形式の API ドキュメントを生成するドックレット。Javadoc の -doclet オプションでドックレットを何も指定しないと、この標準ドックレットが使用されます。
- 5.0 ドックレット API への移行 - 5.0 の新しい言語機能をサポートできるように従来のドックレットを拡張するためのヒント。
- タグレットの概要 - タグレットの概要をタグレット API の使い方の簡単な実例とともに紹介します。
API の拡張機能
詳細情報
- API における非推奨
- Javadoc FAQ - 貴重なヒントとバグの回避方法。