Java

Javadoc 1.4
ツール

Java 2 SDK v1.4 の目次
Javadoc はソースファイルの中の宣言やドキュメンテーションコメントを解析し、 クラス、内部クラス、インタフェース、コンストラクタ、メソッド、およびフィールドについて説明した 一連の HTML ページを生成するツールです。

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

Javadoc に施された機能強化
新機能については、次のドキュメントで説明します。


ドックレット API


タグレット API


ドックレット

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


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

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

詳細情報

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


Copyright © 1997-98 Sun Microsystems, Inc. All Rights Reserved.

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