Java

Javadoc テクノロジ

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

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

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

API の仕様

ツール

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

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

ドックレットの情報:
タグレットの情報:

API の拡張機能

詳細情報

次の JavaTM SE ドキュメントを参照してください。
次の Java Software Web サイトを参照してください。

Copyright © 2006 Sun Microsystems, Inc. All Rights Reserved.

フィードバック
Sun