Maven學習總結（43）——利用javadoc外掛生成專案的API文件
阿新 • • 發佈：2019-02-12
在進行Java學習的時候，相信大家都看過線上或者下載的java api文件，可能是html格式或者chm格式的，其實這些參考文件也是很容易生成的，這裡介紹一個maven的外掛來實現專案程式碼文件的生成。
JDK 7 API1. 在專案的pom.xml檔案中，新增如下程式碼：
注意事項:
（1）jdk8以後的版本添加了doclint，這個工具會規範HTML文件，對於不正確的巢狀，非法的html屬性，未關閉的標籤等，java doc就會生成失敗，所以一個臨時解決方案是將doclint在jdk8中disable掉（-Xdoclint:none）
mvn javadoc:javadoc
生成文件命令
控制檯日誌輸出3. 生成的html文件，會散落在各個功能模組的target/site/apidocs目錄下，雙擊index.html即可檢視生成的文件
生成的文件
JDK 7 API1. 在專案的pom.xml檔案中，新增如下程式碼：注意事項:（1）jdk8以後的版本添加了doclint，這個工具會規範HTML文件，對於不正確的巢狀，非法的html屬性，未關閉的標籤等，java doc就會生成失敗，所以一個臨時解決方案是將doclint在jdk8中disable掉（-Xdoclint:none）
（2）在拷貝上述配置到pom檔案中時，注意標籤的巢狀。譬如：在已有專案中已經存在了profiles標籤，那麼只需拷貝profile之間的內容即可
其他
（3）如果不喜歡看html格式的java文件，可以到網上找工具將html合成chm格式的電子書，方便分發和攜帶
（4）如果在生成java文件時，報出錯誤“編碼GBK的不可對映字元”，可以在pom.xml檔案中設定編碼格式來解決：
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<maven.compiler.encoding>UTF-8</maven.compiler.encoding>
</properties>
mvn javadoc:javadoc
生成文件命令控制檯日誌輸出3. 生成的html文件，會散落在各個功能模組的target/site/apidocs目錄下，雙擊index.html即可檢視生成的文件生成的文件