文檔維護痛點
傳統模式：代碼與文檔分離 → 修改代碼後須同步更新文檔 → 極易脫節、過時、遺漏。
Javadoc 解決方案
- 代碼與文檔「鏈接」：置於同一檔案
- 特殊註釋語法：
/** ... */ 標記文檔區塊
- 提取工具：
javadoc（基於編譯器前端技術）
工作流程
- 編寫代碼時同步撰寫
/** ... */ 註釋
- 執行
javadoc 掃描源碼
- 提取註釋內容 + 相鄰類/方法名
- 生成專業級 HTML 文檔
核心優勢
- 零維護成本：文檔隨代碼自然同步
- 標準化輸出：統一風格，開發者零學習成本
- 全庫覆蓋：Java 標準庫文檔即由此生成
- 瀏覽器即時查看：無需特殊工具
Javadoc 讓「寫文檔」從負擔變為編碼自然一部分，是 Java 生態系統文檔品質極高的關鍵原因。
