JBuilder 2005 產生完整 Javadoc 文件：向導操作全紀錄

編輯器的 Doc 視圖只能預覽片段，缺乏導覽樹與 @see/@link 連結。要產出完整可瀏覽的 API 文件，必須透過 Javadoc 向導。本文以實際截圖步驟，示範從建立節點到輸出 HTML 的完整流程。

啟動 Javadoc 向導

File → New → Build → Javadoc

步驟 1：選擇 Doclet

• Standard Doclet（預設）：JDK 1.3+ 格式，功能完整。
• JDK 1.1 Doclet：舊版相容，JDK 1.4/5.0 會報錯 Cannot find doclet com.sun.tools.doclets.oneone.OneOne，不建議使用。

步驟 2：節點名稱與輸出選項

• Name：專案窗格顯示的節點名（如 Standard Doclet）。
• Output directory：輸出目錄（預設 D:/javadoc/doc）。
• 四個建立選項：
  • ☑ Show console output：輸出報告資訊，建議開啟。
  • ☐ Always run Javadoc When building the project：每次 Rebuild 都產生文件太耗時，建議關閉，手動觸發。
  • ☑ Use project JDK when running Javadoc：使用專案 JDK 的 doclet，確保版本一致。
  • ☐ Include project test path directory：單元測試類別通常不需對外文件，建議關閉。

步驟 3：指定套件與可視範圍

• Entire project：全專案（含測試碼視設定而定）。
• 或取消勾選，用 Add... 指定特定套件。
• Lowest visibility to document：預設 Package（輸出 public/protected/default，不含 private）。

步驟 4：Doclet 命令列參數

Javadoc.exe 擁有 54 個參數，向導提供常用勾選：

• ☑ @author、☑ @version、☑ Generate "Use" page、☑ Separate index per letter
• Additional options：自訂參數，如 -header "Javadoc測試專案" -footer "abc公司版權所有"

產生與瀏覽文件

1. 完成向導 → 專案窗格出現 Standard Doclet 節點。
2. 右鍵節點 → Rebuild → 呼叫 javadoc.exe 產生文件。
3. 展開節點 → 雙擊 index.html → JBuilder 內建瀏覽器預覽。
4. 或至 <專案目錄>/doc 用 IE/Chrome 開啟。

進階技巧：打包成 JAR 發布

若專案為類別庫，將 doc 資料夾與 .class 一起打包成 JAR，使用者引用庫時即可在 IDE 直接查看 Javadoc 提示。