Javadoc 1.3

Javadoc は、ソースファイルセット内の宣言およびドキュメンテーションコメントを構文解析し、クラス、内部クラス、インタフェース、コンストラクタ、メソッド、およびフィールドを記述した HTML ページのセットを生成します。
Javadoc のドックレットを使って、Javadoc の出力をカスタマイズできます。ドックレットとは、javadoc ツールに生成させる出力の内容と形式を指定する、ドックレット API を使用して書かれたプログラムです。 HTML、SGML、XML、RTF、MIF など、任意の種類のテキストファイル出力を生成するドックレットを作成できます。 Sun^TM は、HTML 形式の API ドキュメントを生成する「標準の」ドックレット、および MIF、PDF、PS、RTF、FrameMaker、およびその他の形式を生成する実験的な MIF ドックレットを提供します。ドックレットを使うと、API ドキュメントの生成とは関係のない特殊な処理を行うこともできます。たとえば、Javadoc の処理対象となるクラスのすべてのクラスメンバに、コメントが付けられているかどうかをチェックする診断用ドックレットを作成するといったことができます。

Javadoc に施された機能強化

ここでは、新機能について説明します。

ドックレットの概要

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

ドックレットの概要

ドックレットの API

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

ドックレット API

ドックレット

標準ドックレット - デフォルトの HTML 形式 API ドキュメントを生成するドックレットです。Javadoc の -doclet オプションでドックレットが何も指定されていない場合は、この標準ドックレットが使用されます。
MIF ドックレット - 実験的 - MIF (Maker Interchange Format) 形式で API ドキュメントを生成します。これらの MIF ファイルは、Adobe FrameMaker (または fmbatch) で開くことができ、またオプションで PDF、PS、Microsoft RTF、Microsoft Word、または WordPerfect 形式に変換できます。 Java 2 SDK には含まれていません。
サードパーティ製のドックレット - Sun 以外で開発されたドックレットです。

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

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

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

皆さまの作成したドックレットについてお聞かせください。ドックレットページから自分のドックレットの出力へのリンク追加をご希望の方は、 javadoc-tool@sun.com 宛てに URL をお送りください。

詳細情報

次の Java ソフトウェア Web サイトを参照してください。

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

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