註釋
| 主題: |
| 導航 Javadoc & 註釋 主題： |
Javadoc 是 Java 原始碼文件生成器，從 Java 1.0 版本開始就被引入。 編寫良好的 Java 程式碼應該包含 Javadoc 標籤。 這些標籤位於 /** ... */ 註釋塊中，因此編譯器會忽略它們。 另一個工具將讀取程式碼並建立 Java API html 檔案。
Javadoc API 文件非常有名。 Java JDK 類附帶了 Javadoc API 文件。 大多數流行的 IDE 工具會自動讀取 Javadoc 標籤，並在使用該類、屬性或方法的任何地方，將標籤內容自動顯示在滑鼠游標懸停在文字上的時候。
隨著 Java 的成熟，“Javadoc 概念”被認為是用於其他目的的優秀工具，例如生成 XML 描述符，甚至在 XDoclet 開源程式的幫助下生成 Java 程式碼。
藉助 XDoclet 程式，可以在程式碼中使用額外的 Javadoc 標籤，該程式可以理解這些標籤並生成程式碼或資料。 例如，引入了 Javadoc 標籤來生成 EJB 的 XML 描述符。 它在 EJB 的構建過程中引入了一個額外的步驟，編譯程式碼時，XDoclet 會生成 XML 描述符。
在 Java 5 中，認識到註釋的實用性，註釋 被新增到 Java 語言中。 註釋標籤不在註釋塊內。 註釋是類的一部分，可以在執行時訪問。
在大量使用 XML 描述符的地方，現在可以使用另一種方法，那就是 Java 註釋。 從 EJB 3.0 開始，可以使用 Java 註釋來定義 EJB，而無需使用 XML。 此外，新的 JPA (Java 持久 API) 也使用註釋。
需要注意的是，Javadoc 和註釋是兩種不同的構造。
- Javadoc 標籤位於註釋塊內，因此被編譯器忽略。
- 註釋標籤位於註釋塊之外，並由編譯器進行型別檢查。