Javadoc 5.0 ツール

J2SE の目次

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

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

新機能については、次のドキュメントで説明します。

• Javadoc 5.0 の新機能
• Javadoc 1.4.2 の新機能
• Javadoc 1.4.1 の新機能
• Javadoc 1.4.0 の新機能
• Javadoc 1.3 の新機能
• Javadoc 1.2.2 の新機能
• Javadoc 1.2 の新機能

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

リファレンスページには、すべての javadoc タグとコマンド行オプションが掲載されています。また、Javadoc ツールを実行する方法や、Solaris および Microsoft Windows での実例についても説明しています。

• Javadoc ツールのリファレンスページ (Solaris)
• Javadoc ツールのリファレンスページ (Microsoft Windows)

ドックレット API

• 「ドックレットの概要」 - ドックレットの概要を説明し、ドックレット API の使い方を示す簡単な実例を紹介しています。
• 「5.0 ドックレット API への移行」 - 5.0 の新機能をサポートできるように従来のドックレットを拡張するためのヒントを説明しています。
• 「ドックレット API」 - ドックレット API を構成する com.sun.javadoc パッケージについて説明しています。

タグレット API

• 「タグレットの概要」 - タグレットの概要を説明し、ドックレット API の使い方を示す簡単な実例を紹介しています。
• 「インタフェースタグレット」 - タグレット API を構成する com.sun.tools.doclets.Taglet クラスについて説明しています。

ドックレット

• 標準ドックレット - デフォルトの HTML 形式 の API ドキュメントを生成するドックレット。Javadoc の -doclet オプションでドックレットを何も指定しないと、この標準ドックレットが使用される

• MIF ドックレット - 実験的 - MIF (Maker Interchange Format) 形式で API ドキュメントを生成する。これらの MIF ファイルは、Adobe FrameMaker (または fmbatch) で開くことができる。また、オプションとして、PDF、PS、Microsoft RTF、Microsoft Word、または WordPerfect 形式に変換できる。J2SE には含まれていない。

• DocCheck ドックレット - 実験的 - ソースコード内の Javadoc コメントをチェックして、不足のある箇所や不規則な箇所を識別し、重大な問題と小さな問題、そして変更方法の提案を示す HTML レポートを生成する

• サードパーティ製のドックレット - Sun 以外で開発されたドックレット

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

次の J2SE ドキュメントを参照してください。

• 推奨されていないタグ

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

• Javadoc FAQ - 貴重なヒントとバグの回避方法
• Javadoc Forum - 他の開発者との討論に参加できます。参加するには、Java Developer Connection に会員登録する必要があります (無料)。「Javadoc Tool」カテゴリをクリックしてください。Javadoc チームでは、このフォーラムの定期的な確認は行っていません。Javadoc チームからすぐに返信が必要な場合は、下記の電子メールアドレスをご利用ください。
• バグレポートの送信
  1. 「What Bugs Are in Javadoc?」 - そのバグや機能要求がデータベースにすでに登録されていないかどうか調べてください。
  2. 「How Do I Submit Bugs and Feature Requests?」 - まだ登録されていない場合は、この手順に従ってバグや機能要求を送信してください。
• Javadoc メーリングリスト - 情報提供用に公開されているメーリングリストです。このメーリングリストに登録すると、Javadoc ツール、標準ドックレット、MIF ドックレット、DocCheck ドックレット、地域対応ドックレット、その他に関して公表される主な情報を受け取ることができます。メールサイズはあまり大きくありません。
• Javadoc チームの電子メールアドレス - Javadoc チームでは、すべてのメールに目を通しています。すべてに返信するように努力していますが、必ず返信できるとは限りません。
• Javadoc ツールのホームページ - java.sun.com の Web サイトは、すべてのバージョンの Javadoc ツールを対象にしています。

Copyright © 1997-2004 Sun Microsystems, Inc. All Rights Reserved. コメントの送付先: