Maven JXR 插件

JXR 插件生成项目源代码的交叉引用。生成的报告使用户更容易参考或查找特定的代码行。当与 PMD 插件一起使用以引用代码中发现的错误时,它也很方便。

目标概述

JXR 插件有 6 个目标:

  • jxr:jxr用于生成项目主要来源的交叉引用页面。生成的 JXR 文件可以链接到项目的 javadocs。
  • jxr:jxr-no-fork用于生成项目主要来源的交叉引用页面,而无需generate-sources再次分叉阶段。请注意,此目标确实需要在站点生成之前生成主要源,例如通过调用mvn clean deploy site.
  • jxr:aggregate用于生成项目主要来源的聚合交叉引用页面。生成的 JXR 文件可以链接到项目的 javadocs。
  • 另一方面, jxr:test-jxr用于生成项目测试源的交叉引用页面。
  • 另一方面, jxr:test-jxr-no-fork用于生成项目测试源的交叉引用页面。无需再次分叉generate-test-sources相位。请注意,此目标确实需要在站点生成之前生成测试源,例如通过调用mvn clean deploy site.
  • 另一方面, jxr:test-aggregate用于生成项目测试源的聚合交叉引用页面。

用法

关于如何使用 JXR 插件的一般说明可以在使用页面上找到。下面给出的示例中描述了一些更具体的用例。最后但同样重要的是,用户偶尔会向插件的 wiki 页面提供额外的示例、提示或勘误表。

如果您对插件的使用仍有疑问,请查看常见问题解答并随时联系用户邮件列表。邮件列表中的帖子已存档,并且可能已经包含您问题的答案,作为旧线程的一部分。因此,也值得浏览/搜索邮件存档

如果您觉得插件缺少功能或存在缺陷,您可以在我们的问题跟踪器中填写功能请求或错误报告。创建新问题时,请提供您所关注问题的全面描述。特别是对于修复错误,开发人员可以重现您的问题至关重要。出于这个原因,非常感谢附在问题上的整个调试日志、POM 或最好的小演示项目。当然,补丁也是受欢迎的。贡献者可以从我们的源代码库中查看该项目,并将在帮助使用 Maven 的指南中找到补充信息。

例子

为了让您更好地了解 JXR 插件的一些用法,您可以查看以下示例: