Javadoc

Javadoc（上代先是JavaDoc）是由 Sun Microsystems 為 Java 語言（這陣由甲骨文公司有擁有）創建的文檔生成器，用佇對 Java 原始碼生成 HTML 格式的 API 文檔，HTML 格式用佇增加將相關文檔牽連做伙的便利性。

Javadoc 使用的「doc comments」格式是記錄 Java 類的事實上的行業標準。一寡仔 IDE，如 IntelliJ IDEA、NetBeans 和 Eclipse，你自動生會當變成 Javadoc HTML。真濟文件編輯器幫贊用戶生成 Javadoc 原始碼並使用 Javadoc 信息做為程式設計師的內部引用。

Javadoc 閣提供用佇創建 doclet 和 taglet 的 API，允准用戶分析 Java 應用程式的結構，這就是 JDiff 欲按怎生兩个 API 版本之間發生變化的報告。

Javadoc 無影響 Java 中的性能，因為佇咧編譯的時陣會刪除所有注釋。編寫注釋佮 Javadoc 是為著閣較好的理解代碼，從而且閣較好維護代碼。

歷史

Javadoc 是古早的 Java 語言文檔生成器。佇咧用這个文檔生成器進前，習慣上由專業的技術編寫者編輯文檔，𪜶通常干焦編寫軟體的獨立文檔，毋過遮的文檔佮軟體本身保持仝步欲困難得濟。

自頭一个版本以來，Java 一直使用 Javadoc，並且通常佇咧 Java 開發工具包的逐个新版本上攏會更新。

技術架構

Javadoc 注釋結構

通過標準濟行注釋標記 ` / * ` and ` * / ` 對代碼中引發 Javadoc 注釋。開始標記（這个稱做開始-注釋分隔符）有額外的星號，如 ` / * * ` 中所示。

一 . 頭一段是對記錄方法咧描述。 二 . 欲描述了後是無仝數量伊講的標籤，表示： 一 . 方法的參數（` @ param `） 二 . 方法倒轉來的內容（` @ return `） 三 . 方法可能拋出的任何異常（` @ exception `） 四 . 其他無啥會當看著的標籤，如 ` @ see `（「 另見」標籤）

Javadoc 概覽

編寫文檔注釋的基本結構是共𪜶躉入去到 ` / * * . ` 中。Javadoc 寫佇項目邊仔，無任何分隔換行符。請注意，任何 import 語句著愛佇咧類聲明進前。類聲明通常包括：

對方法，有如（一）所示的素潔的一行描述來解說項目的作用；紲落來是（二）所示的閣較長的描述，該描述會當迒過真濟站落來並且是會當有路無的；最後咧，第（三）部份列出接受的輸入參數佮方法的倒轉來值。所有的 Javadoc 攏予人看做是 HTML，因此多個段落部分由 " ` < p > ` " 段落符號分隔。

佮方法類似的注釋嘛會當用於變量的注釋，毋過省起來矣第（三）部份，遮干焦包含著變量簡短來講：

請注意，無建議佇咧單個文檔注釋中定義濟个變量。這是因為 Javadoc 讀每一个變量閣共伊分別囥到生的 HTML 頁面，其中包括為所有欄位複製的仝款文檔注釋。

相反，建議分別聲明佮注釋逐个變量：

Javadoc 標籤表

一部份會當用的 Javadoc 標籤列佇下表中：

示例

下跤是注釋一个方法的 Javadoc 示例。

參見

• 文檔生成器的較
• . Net 的 XML 文檔注釋