讀古今文學網 > Maven實戰 > 15.3.1 JavaDocs >

15.3.1 JavaDocs

這可能是最簡單、也最容易理解的報告插件了。maven-javadoc-plugin使用JDK的javadoc工具,基於項目的源代碼生成JavaDocs文檔。該插件的配置如代碼清單15-3所示。

代碼清單15-3 配置maven-javadoc-plugin插件

基於上述簡單的配置,當用戶使用mvn site命令生成站點時,就能得到項目主源碼和測試源碼的JavaDocs文檔,如圖15-4所示。

圖15-4 插件報告列表

圖15-4左側的導航欄有兩個類別,Project Information包含了15.2節講述的各類基本信息,Project Reports則包含其他插件生成的報告。這裡能看到maven-javadoc-plugin生成JavaDocs和Test JavaDocs文檔,單擊相應鏈接就能查看具體文檔,如圖15-5所示。

圖15-5 JavaDocs文檔

在生成項目站點文檔的時候,一個常見的問題是:用戶往往只希望在聚合項目一次性生成融合了所有模塊信息的文檔,而不是為每個模塊單獨生成,原因就是為了方便。用戶總是希望在一個地方看到盡可能全面的信息,而非不停地單擊鏈接。幸運的是,maven-javadoc-plugin考慮到了這一點,使用該插件的最新版本,用戶無須任何額外的配置,就能在聚合項目的站點中得到包含所有模塊的JavaDocs,配置見代碼清單15-3。