註釋

主題: 前言 入門 語言基礎 類和物件 聚合 異常 併發程式設計 Javadoc & 註釋 設計使用者介面 高階主題

導航 Javadoc & 註釋 主題： Javadoc 註釋介紹 建立自定義註釋 元註釋 幫助編譯器

Javadoc 是 Java 原始碼文件生成器，從 1.0 版開始就隨 Java 語言一起引入。 編寫良好的 Java 程式碼應該包含 Javadoc 標籤。 這些標籤位於 /** ... */ 註釋塊中，因此編譯器會忽略它們。 一個單獨的實用程式將讀取程式碼並建立 Java API html 檔案。

Javadoc API 文件是眾所周知的。 Java JDK 類附帶 Javadoc API 文件。 大多數流行的 IDE 工具會自動讀取 Javadoc 標籤，並在使用該類、屬性或方法的地方，當滑鼠游標懸停在文字上時，會自動顯示標籤內容。

隨著 Java 的成熟，“Javadoc 概念”被認為是用於其他目的的出色工具，例如使用 XDoclet 開源程式生成 XML 描述符，甚至生成 Java 程式碼。

藉助 XDoclet 程式，可以在程式碼中使用額外的 Javadoc 標籤，該程式可以理解這些標籤並生成程式碼或資料。 例如，引入了 Javadoc 標籤來為 EJB 生成 XML 描述符。 它在 EJB 的構建過程中引入了一個額外的步驟，並且在編譯程式碼時，XDoclet 將生成 XML 描述符。

認識到它的有用性，在 Java 5 中，註釋 被新增到 Java 語言中。 註釋標籤不在註釋塊內。 註釋是類的一部分，可以在執行時訪問。

在 XML 描述符被大量使用的地方，現在可以使用 Java 註釋作為一種替代方法。 從 EJB 3.0 開始，可以定義 EJB，而無需使用 XML。 此外，新的 JPA (Java 持久 API) 使用註釋。

重要的是要注意，Javadoc 和註釋是兩種不同的構造。

• Javadoc 標籤位於註釋塊內，因此被編譯器忽略。
• 註釋標籤位於註釋塊之外，並且由編譯器進行型別檢查。