Javadocテクノロジ

Javadocは、ソース・ファイル・セット内の宣言およびドキュメンテーション・コメントを解析し、クラス、インタフェース、コンストラクタ、メソッド、およびフィールドについて記述したHTMLページ・セットを生成するツールです。

Javadocのドックレットを使用してJavadocの出力をカスタマイズできます。ドックレットとは、ドックレットAPIを使用して書かれたプログラムのことで、ツールで生成するべき出力の内容と形式を指定しています。HTML、SGML、XML、RTF、MIFなど、任意の種類のテキスト・ファイル出力を生成するためのドックレットを作成できます。HTML形式のAPIドキュメントを生成する標準ドックレットが、Oracleから提供されています。さらに、ドックレットを使うと、APIドキュメントの生成とは関係のない特別な処理を行うこともできます。

タグレットは、-tagオプションを使用して作成されたカスタム・タグより柔軟性のあるカスタム・タグを作成し使用することのできるプログラムです。カスタム・タグは、Javadocタグからテキストの書式設定と表示を行うためにドックレットで使用されます。タグレットは、タグレット・インタフェースを実装する必要があります。

API仕様

次に、Javadocに関連するAPIを示します。

ドックレットAPI - ドックレットAPIはcom.sun.javadocパッケージに含まれています。
タグレットAPI - タグレットAPIはcom.sun.tools.doclets.Tagletクラスに含まれています。
ドックツリーAPI - ドックツリーAPIはcom.sun.source.doctreeパッケージに含まれています。このAPIを使用すると、抽象構文ツリーとしてJavadocコメントを横断できます。
JavadocアクセスAPI - JavadocアクセスAPIはjavax.toolsパッケージに含まれています。このAPIを使用すると、新しいプロセスを実行せずに、Javaアプリケーションから直接Javadocツールを起動できます。

ツール

このページでは、Javadocツールを実行するためのすべてのjavadocタグとコマンド行オプションを、SolarisおよびMicrosoft Windowsオペレーティングシステムで使用する場合の例とともに一覧表示します。

チュートリアルおよびプログラマーズ・ガイド

このセクションでは、Javadoc APIのチュートリアルおよびガイドを示します。

ドックレットの概要 - この標準ドックレットの紹介では、ドックレットAPIの使い方の簡単な実例を示します。
標準ドックレットの実行 - デフォルトのHTML形式のAPIドキュメントを生成するドックレット。Javadocの-docletオプションでドックレットを何も指定しないと、この標準ドックレットが使用されます。
5.0ドックレットAPIへの移行 - このドキュメントでは、5.0の新しい言語機能をサポートするように従来のドックレットを拡張するためのヒントを示します。
タグレットの概要 - このタグレットの紹介では、タグレットAPIの使い方の簡単な実例を示します。

APIの拡張機能

次のリストには、特定のリリースでのJavadocの機能および拡張機能を示します。

詳細情報

詳細は、次を参照してください。

APIの非推奨 - Javadocツールで生成されたドキュメントで非推奨になっているAPI、およびAPIを非推奨にする方法を学習します。
Javadoc FAQ - 貴重なヒントとバグの回避方法を確認します。
Javadocフォーラム - 開発者同士の議論に参加します。このフォーラムは、たまにしかJavadocチームによってモニターされません。

連絡先