1 准備工作
1.1 填寫完整的注釋
對需要生成API的類,填寫完整的注釋,包括類注釋,方法注釋,具體格式如下:
類注釋:
原先可能author是作者,需要修改成author英文的,
另外去掉
方法注釋:
每一個方法的參數注釋都要有意義,沒有參數的就不需要參數注釋
1.2 新建一個臨時目錄
在你的電腦的任意位置新建一個文件夾,比如是JavaDoc,用來放置導出的javadoc文件,我這邊新建的是D:\JavaDoc
1.3 准備API生成工具
,解壓到任意目錄即可,我這邊解壓到如下位置: C:\jd2chm_0.34
至此,准備工作完畢,可以開始生成了
2 生成JavaDoc文檔
2.1 選擇你需要生成API的類,或者是包,右鍵選擇Export,選擇Javadoc
2.2 點擊next,選擇目標文件夾為之前創建的JavaDoc
2.3 點擊next,上面的checkbox全部打上勾
2.4 點擊next,參數里面添加編碼: -encoding UTF-8 -charset UTF-8,因為我們一般都是采用UTF-8編碼,不設置的話導出會出現問題
2.5 點擊finish,查看控制台的打印信息,看是否有報錯和警告,有的話可以看提示相應解決
3 生成API文檔
1
3.1 首先查看我們的JavaDoc是否成功導出
3.2 開始，Cmd進入命令窗口
3.3 切換到我們剛才解壓的工具目錄
輸入cd C:\jd2chm_0.34，按回車
3.4 運行工具程序
輸入：jd2chm.exe，按回車，出現如下界面
3.5 輸入JavaDoc目錄
輸入F:\docAPI，按回車
3.6 輸入API文檔名字
輸入組織架構API，按回車
3.7 其他配置如下
最后一個選擇y后按回車，就開始生成API了
成功生成結果如圖：
4 一些其他小修飾
4.1 閱讀chm文檔
雙擊chm文檔，我們可以看到如下內容：
每個方法的詳細說明都可以看見
4.2 去除說明
但是目錄里面的最上面有一個如下的說明：
解壓安裝如下工具：
安裝完畢后雙擊快捷方式打開：
文件，打開D:\JavaDoc\組織架構API.hhp文件
切換到目錄，把about刪掉
點擊編譯按鈕(眼鏡左邊的)：
完成后我們再打開chm文檔：不再有about了，當然你也可以修改about的信息
5 FAQ
E:\項目\FrameTenantTable.java:1: 非法字符： \65279
可以將java文件copy出來，用文檔編輯器打開后另存utf-8格式，再copy回來即可
jd2chm_0.34、HA_HHWorkShop474_ljh 這2個工具包可以網上自行下載