Java

Javadoc 增強功能

JDK 1.2 目錄

Javadoc 是一種工具,它用於對一組源文件中的聲明和文件注釋進行語法分析,並產生一組 HTML(HyperText Markup Language,超文本標記語言)頁,描述類、內部類、介面、構造函數、方法和域。

您可以使用 Javadoc doclets 自定義 Javadoc 輸出。doclet 是一個用 doclet API(Application Programming Interface,應用程式介面)編寫的程式,它指定用 javadoc 工具產生的輸出的內容和格式。您可以編寫 doclet 來產生任意種類的文本文件輸出,例如 HTML、SGML、XML、RTF 和 MIF。SunTM 提供一個“標準”doclet,用來產生 HTML 格式的 API 文件。Doclets 可用來執行與產生與 API 文件無關的特殊任務。例如,可以創建診斷 doclet,檢查 Javadoc 所操作的類的所有類成員是否都有文件注釋。

Javadoc 增強功能

描述 JDK 1.1 以後增加的新功能。


Doclet 概述

提供對 doclets 的介紹,包括說明 doclet API 的簡單示例。


Doclet API

com.sun.javadoc 包的文件,該包組成 doclet API。


標準 Doclet

標準 doclet 是 Sun 提供的 doclet,它產生預設 HTML 格式的 API 輸出。如果沒有用 Javadoc 的 -doclet 選項指定其它 doclet,則 Javadoc 使用標準 doclet。該文件是對標準 doclet 的簡介。

Javadoc 工具參考頁

參考頁顯示如何使用 Javadoc 工具,包括對可用命令行選項的說明。


讓我們了解您的 Doclets

我們願意了解您所創建的 doclets。如果您願意讓我們建立從 java.sun.com 網站到您的 doclet 輸出的鏈接,請向 javadoc-tool@sun.com 發送消息,其中附上 doclet 的樣本輸出或指向您的 doclet 輸出的Internet URL。如果您想讓其它用戶在網站上隨意使用您的 doclet 原始程式,就請將原始程式發送給我們。


詳細資訊

請訪問 JavaSoft 站點:


Outsource Laboratories, Inc(Java/Javascript 開發和培訓公司) Cameron Gregory 的貢獻和靈感,我們表示由衷感謝


版權所有 © 1997-98 Sun Microsystems, Inc. 保留所有權利。如有意見,請發送至:javadoc-tool@sun.com Sun