用PMD运行代码检查

最新推荐文章于 2025-09-13 11:30:01 发布

原创最新推荐文章于 2025-09-13 11:30:01 发布 · 2.1k 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#reference #html #ant #include #任务 #report

Java 专栏收录该内容

7 篇文章

订阅专栏

本文介绍了一种利用自动化工具提高代码审查效率的方法。通过使用PMD等工具，可以在构建过程中自动执行代码检查，并生成详细的报告。这有助于确保代码质量并减少人工审查的工作量。

可以实现代码检查自动化。尽管不能消除手动代码检查需求，但建议的最佳实践是，采用自动化检查来确定开发团队在代码质量标准方面所处的位置。Rational SDP 提供了内置的代码检查支持。（有关如何从 Ant 进行调用的更多信息，请参见 Code review headless mode reference。）

另外还可以使用多种工具来执行自动化代码检查，如 PMD 和 CheckStyle。清单 3 中的示例说明了如何将 PMD 作为 Ant 任务调用并生成 HTML 格式的结果。要运行此任务，需要将 pmd-3.8.jar、jakarta-oro-2.0.8.jar 和 jaxen-1.1-beta-10.jar 放置在 lib.dir 属性所指定的目录。

清单 3. 使用 PMD 进行自动化代码检查

                        
<target name="reviewcode" description="Review code using PMD">
  <taskdef name="pmd" classname="net.sourceforge.pmd.ant.PMDTask" 
  classpath="${lib.dir}/pmd-3.8.jar" />
    <pmd shortFilenames="true">
	<!-- Determine the ruleset to be used -->
	<ruleset>rulesets/favorites.xml</ruleset>
	<ruleset>basic</ruleset>
	<!-- Generate and HTML report into the designated directory -->
	<formatter type="html" 
toFile="${report.dir}/pmd_automated_code_review_report.html" />
	<!-- Files to be configured for review -->
	<fileset dir="${workspace.dir}/">
	<!-- Include all .java files except those under directories that are 
	   automatically generated -->
	<include name="**/*.java" />
	<!-- A sample exlusion directory that has generated java source code -->
	<exclude name="**/generated/**/*.java" />
	</fileset>
	</pmd>
</target>