Javadoc に施された機能強化

Javadoc は、一連のソースファイルの宣言部分とコメント部分を解析し、使用されているクラス、内部クラス、インタフェース、コンストラクタ、メソッド、およびフィールドについて説明した一連の HTML ページを生成するツールです。
Javadoc の出力は、Javadoc のドックレットを使用することでカスタマイズできます。ドックレットとは、javadoc ツールに生成させる出力の内容と形式を指定する、ドックレット API を使用して書かれたプログラムです。ドックレットを作成すれば、HTML、SGML、XML、RTF、MIF などのテキストファイルであれば、どのような種類のものでも生成できます。Sun は、API の HTML 形式のドキュメントを生成する「標準」ドックレットを提供しています。ドックレットは、API のドキュメントを生成する以外の特別な用途にも使用できます。たとえば、Javadoc の処理対象となるクラスのすべてのクラスメンバに、コメントが付けられているかどうかをチェックする診断用ドックレットを作成するといったことができます。

Javadoc に施された機能強化

JDK 1.1 以降で追加された新機能について説明します。

Javadoc 1.2 の新機能

ドックレットの概要

ドックレット API の使い方が学べる簡単な例を使用して、ドックレットの概要を説明します。

ドックレットの概要

ドックレット API

ドックレット API を構成する com.sun.javadoc パッケージの説明です。

com.sun.javadoc パッケージ

標準ドックレット

標準ドックレットとは、デフォルトの HTML 形式の API 出力を生成するための、Sun が提供するドックレットです。Javadoc の -doclet オプションでドックレットが何も指定されていない場合は、この標準ドックレットが使用されます。次の文書では、標準ドックレットの概要を説明しています。

標準ドックレット

Javadoc ツールリファレンスページ

リファレンスページでは、指定できるコマンド行オプションの説明を始めとして、Javadoc ツールの使い方を説明しています。

作成したドックレットの公開について

皆さまの作成したドックレットについてお聞かせください。皆さまのドックレットの出力へのリンクを java.sun.com の Web サイトに追加ご希望の方は、ドックレットのサンプル出力か、インターネット上にドックレットの出力がある場合はその出力の URL を添えて javadoc-tool@sun.com までご連絡ください。作成したドックレットのソースコードを Web サイトで無料公開なさりたい場合は、ソースコードもお送りください。

詳細情報

Java ソフトウェアの次の Web サイトをご覧ください。

Javadoc ホームページ
Javadoc FAQ - 貴重なヒントとバグの回避方法
Javadoc ニュースグループ - 詳細は、Javadoc ホームページをご覧ください。

Java/Javascript の開発およびトレーニング企業 Outsource Laboratories, Inc の Cameron Gregory 氏によるアイデアと協力に感謝致します。

コメントの送付先: javadoc-tool@sun.com