Javadoc 文檔生成完全指南：標準標簽、Maven 集成與現代最佳實踐

javadoc 是 JDK 內置的 API 文檔生成工具，從源碼中的文檔註釋 (/ ** ... * /)提取結構化信息，生成標準 HTML 文檔。掌握標準標簽、模塊化文檔、Maven/Gradle 集成、自定義 Doclet，是構建可維護、可傳遞、可檢索技術文檔的關鍵。

標準文檔註釋結構

/**
 * 類/接口/枚舉/註解/記錄/模塊/包/方法/字段/類型參數 的簡短摘要 (第一句，以句號結束)。
 * 

 * 詳細描述：功能、用法、線程安全性、異常拋出條件、性能特徵、參考鏈接等。
 * 可使用 HTML 標簽 (<p> <code> <pre> <ul> <li> <a href="...">)。
 *
 * @author 作者名
 * @version 版本號 (如 1.2.3)
 * @since 從哪個版本開始存在 (如 2.0)
 * @see 參考鏈接 (類#方法、URL、包)
 * @deprecated 棄用說明 (配合 @Deprecated 註解)
 */
public class Example { ... }

核心標準標簽完整表

標簽	適用對象	語法示例	說明
@param	方法、構造器	@param name description	參數說明，必寫所有參數
@return	方法 (非 void)	@return description	返回值含義、可能值範圍、null 情況
@throws / @exception	方法、構造器	@throws ExceptionType condition	拋出異常類型及觸發條件，**必寫**所有受檢/運行時異常
@see	所有	@see ClassName#methodName @see "外部鏈接"	交叉引用，生成「See Also」區域
@since	所有	@since 1.5	版本引入信息
@version	類、接口	@version 2.3.1	版本號 (配合 SCM)
@author	類、接口	@author Zhang San	作者 (多人用多行)
@deprecated	所有	@deprecated Use {@link NewClass} instead	棄用說明及替代方案
@serial / @serialField / @serialData	Serializable 類/字段	@serial field description	序列化形式文檔
{@link / {@linkplain	內聯 (任意文本中)	{@link String#length()}	生成超鏈接，linkplain 不用等寬字體
{@code	內聯	{@code List}	等寬字體代碼片段，自動轉義 HTML
{@literal	內聯	{@literal 上一篇文章： Hibernate 利用配置文件自動生成數據庫 Schema：SchemaExport 實戰指南 下一篇文章： Hibernate 二級緩存實戰：Ehcache 配置與註解驅動完整指南 Java 相關知識 PureMVC 在 Swing 應用中的實戰入門：架構解析與範例實作 前言 PureMVC 是一個輕量級 MVC 框架，源自 Fl Tomcat 4 Servlet 2.3 Filter 完整指南：從原理到實戰的兩個過濾器範例 Filter 在 J2EE 請求處理管道中的定位 Servl Java 獲取當前方法名、檔案名、行號完整實作指南 前言 在日誌記錄、除錯追蹤等場景中，常需要自動獲取「當前執行 HashSet vs HashMap 核心區別一覽：底層結構、去重邏輯、使用場景全對比 核心區別表 維度HashSetHashMap 實現接 Java 多線程創建方式一：繼承 Thread 類、八大構造器、start() 與 run() 區別 Jackson 處理複雜物件集合轉換的多種場景實戰 深入理解 Java 巢狀類與內部類 Java 觀察者模式實戰：基於 JDK 內建 Observable 與 Observer 完整指南 J2ME/J2EE 移動端登錄交互實戰：Servlet 與 MIDlet 完整實現 Java 遍歷 Map 的四種核心方式：效能對比、適用場景與最佳實踐 J/XFS 入門（二）：開發金融裝置服務的核心概念與 FDI 實作 欄目導航 Java 程式設計入門 Java 相關知識 J2EE J2SE J2ME Java 綜合教學 Copyright © 程式碼之家 All Rights Reserved