首页 » Maven实战 » Maven实战全文在线阅读

《Maven实战》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。