清单 1. 将 CheckStyle 用于 Ant
<taskdef resource="checkstyletask.properties" classpath="${checkstyle.jar}"/> <checkstyle config ="${basedir}/cs-rules.xml" failOnViolation="false"> <formatter toFile="${checkstyle.data.file}" type="xml" /> <fileset casesensitive="yes" dir="${src.dir}" includes="**/*.java" /> </checkstyle> <xslt taskname="checkstyle" in="${checkstyle.data.file}" out="${checkstyle.report.file}" style="${checkstyle.xsl.file}" /> |
config
被设置成 cs-rules.xml
,这表示将根据源代码目录(在 fileset dir
属性中)以递归的方式运行规则文件。xslt
任务接受根据 formatter toFile
属性生成的文件。该任务使用 XSL 文件 checkstyle.xsl 将清单 1 生成的 XML 转换成一个可读的 HTML 文件,XSL 文件 checkstyle.xsl 包含在 CheckStyle 安装文件中。
清单 2 是 CheckStyle 规则文件的示例片段。CheckStyle 可以在代码基上运行 120 多个规则。