15.3.2 Source Xref

如果能够随时随地地打开浏览器访问项目的最新源代码,那无疑会方便团队之间的交流。maven-jxr-plugin能够帮助我们完成这一目标,在生成站点的时候配置该插件,Maven就会以Web页面的形式将Java源代码展现出来。该插件的配置如代码清单15-4所示。

代码清单15-4 配置maven-jxr-plugin插件


<reporting>

<plugins>

<plugin>

<groupId>org.apache.maven.plugins</groupId>

<artifactId>maven-jxr-plugin</artifactId>

<version>2.2</version>

</plugin>

……

</plugins>

</reporting>


若想在聚合模块整合所有的源码,则需添加额外的aggregate配置,如代码清单15-5所示。

代码清单15-5 在聚合项目配置maven-jxr-plugin插件


<reporting>

<plugins>

<plugin>

<groupId>org.apache.maven.plugins</groupId>

<artifactId>maven-jxr-plugin</artifactId>

<version>2.2</version>

<configuration>

<aggregate>true</aggregate>

</configuration>

</plugin>

……

</plugins>

</reporting>


生成的源码交叉引用报告如图15-6所示。

在这个源码交叉引用文档中,所有源码文件都通过超链接相连,如果之前配置了JavaDocs报告,用户还能直接转到源码文件对应的JavaDoc。

15.3.2 Source Xref - 图1

图 15-6 源码交叉引用文档