必需参数

姓名	类型	自从	描述
包括	细绳	2.8	指定要用于 Checkstyle 的源文件的名称过滤器。 默认值为：**/*.java。
输出目录	文件	2.8	报告的输出目录。请注意，仅当直接从命令行运行目标时才会评估此参数。如果目标作为站点生成的一部分间接运行，则使用在 Maven 站点插件中配置的输出目录。 默认值为：${project.reporting.outputDirectory}。
源目录	文件	2.8	指定要用于 Checkstyle 的源目录的位置。 默认值为：${project.build.sourceDirectory}。

可选参数

姓名	类型	自从	描述
缓存文件	细绳	2.8	指定用于在连续运行中加速 Checkstyle 的缓存文件。 默认值为：${project.build.directory}/checkstyle-cachefile。
配置位置	细绳	2.8	指定要使用的 XML 配置的位置。 潜在值是文件系统路径、URL 或类路径资源。此参数期望位置的内容符合规则集的 xml 格式（Checkstyle Checker 模块）配置。 此参数被解析为资源、URL 和文件。如果成功解析，配置的内容将被复制到 ${project.build.directory}/checkstyle-configuration.xml 文件中，然后作为配置传递给 Checkstyle。 有 4 个预定义的规则集。 config/sun_checks.xml：Sun 检查。 config/turbine_checks.xml：涡轮检查。 config/avalon_checks.xml：阿瓦隆检查。 config/maven_checks.xml：Maven 源代码检查。 默认值为：config/sun_checks.xml。
控制台输出	布尔值	2.8	将错误输出到控制台。 默认值为：false。
enableFiles总结	布尔值	2.8	指定是否应启用文件摘要。 默认值为：true。
启用RSS	布尔值	2.8	指定是否应启用 RSS。 默认值为：true。
enableRules总结	布尔值	2.8	指定是否应启用规则摘要。 默认值为：true。
enableSeveritySummary	布尔值	2.8	指定是否应启用严重性摘要。 默认值为：true。
编码	细绳	2.2	读取源文件时使用的文件编码。如果未设置属性project.build.sourceEncoding，则使用平台默认编码。注意：此参数始终覆盖Checkstyle 的TreeWalker模块中的属性字符集。默认值为：${project.build.sourceEncoding}。
排除	细绳	2.8	指定要为 Checkstyle 排除的源文件的名称过滤器。
失败错误	布尔值	2.8	指定构建是否应因违规而失败。 默认值为：false。
标头位置	细绳	2.0-beta-2	指定 Checkstyle 可以使用的许可证文件（也称为头文件）的位置，以验证源代码是否具有正确的许可证头。 您需要在 Checkstyle xml 配置中使用 ${checkstyle.header.file} 来引用此头文件的名称。 例如： <module name="RegexpHeader"> <property name="headerFile" value="${checkstyle.header.file}"/> </module> 默认值为：LICENSE.txt。
包括TestSourceDirectory	布尔值	2.2	包含或不包含用于 Checkstyle 的测试源目录。 默认值为：${false}。
链接外部参照	布尔值	2.1	将违规行号链接到源外部参照。如果正在使用 Maven JXR 插件，将自动链接。 默认值为：true。
输出文件	文件	2.8	指定保存 checkstyle 输出的路径和文件名。输出文件的格式由 outputFileFormat参数确定。 默认值为：${project.build.directory}/checkstyle-result.xml。
输出文件格式	细绳	2.8	指定写入输出文件时要使用的输出格式。有效值为“plain”和“xml”。 默认值为：xml。
属性位置	细绳	2.0-beta-2	指定属性文件的位置。 这个参数被解析为 URL，文件然后资源。如果成功解析，属性位置的内容将被复制到 ${project.build.directory}/checkstyle-checker.properties 文件中，然后再传递给 Checkstyle 进行加载。 propertiesLocation的内容将提供给 Checkstyle 用于指定 xml 配置中的参数值（在configLocation 参数中指定）。
财产扩张	细绳	2.8	允许指定原始属性扩展信息。
跳过	布尔值	2.2	跳过整个检查。 默认值为：false。
抑制文件表达式	细绳	2.1	要在抑制文件的属性中使用的键。 默认值为：checkstyle.suppressions.file。
抑制位置	细绳	2.0-beta-2	指定要使用的抑制 XML 文件的位置。 此参数被解析为资源、URL 和文件。如果成功解决，则将抑制 XML 的内容复制到 ${project.build.directory}/checkstyle-supressions.xml 文件中，然后再传递给 Checkstyle 进行加载。 有关将可用于您的 checkstyle 配置的属性，请参阅suppresssFileExpression 。
测试源目录	文件	2.2	指定要用于 Checkstyle 的测试源目录的位置。 默认值为：${project.build.testSourceDirectory}。
使用文件	文件	2.8	如果为null，Checkstyle 插件将在标准输出上显示违规。否则，将创建一个包含违规的文本文件。
外部参照位置	文件	2.8	要链接到的外部参照的位置。 默认值为：${project.reporting.outputDirectory}/xref。

参数详情

缓存文件：

• 类型：java.lang.String
• 从: 2.8
• 要求：否
• 默认值：${project.build.directory}/checkstyle-cachefile

---

配置位置：

• 类型：java.lang.String
• 从: 2.8
• 要求：否
• 表达式：${checkstyle.config.location}
• 默认值：config/sun_checks.xml

---

控制台输出：

• 类型：布尔值
• 从: 2.8
• 要求：否
• 默认值：假

---

enableFiles总结：

• 类型：布尔值
• 从: 2.8
• 要求：否
• 表达式：${checkstyle.enable.files.summary}
• 默认值：真

---

启用RSS：

• 类型：布尔值
• 从: 2.8
• 要求：否
• 表达式：${checkstyle.enable.rss}
• 默认值：真

---

enableRules总结：

• 类型：布尔值
• 从: 2.8
• 要求：否
• 表达式：${checkstyle.enable.rules.summary}
• 默认值：真

---

启用严重性摘要：

• 类型：布尔值
• 从: 2.8
• 要求：否
• 表达式：${checkstyle.enable.severity.summary}
• 默认值：真

---

编码：

• 类型：java.lang.String
• 从: 2.2
• 要求：否
• 表达式：${编码}
• 默认值：${project.build.sourceEncoding}

---

不包括：

• 类型：java.lang.String
• 从: 2.8
• 要求：否
• 表达式：${checkstyle.excludes}

---

失败错误：

• 类型：布尔值
• 从: 2.8
• 要求：否
• 默认值：假

---

标头位置：

• 类型：java.lang.String
• 自：2.0-beta-2
• 要求：否
• 表达式：${checkstyle.header.file}
• 默认：许可证.txt

---

包括TestSourceDirectory：

• 类型：布尔值
• 从: 2.2
• 要求：否
• 默认值：${false}

---

包括：

• 类型：java.lang.String
• 从: 2.8
• 要求：是
• 表达式：${checkstyle.includes}
• 默认值：**/*.java

---

链接外部参照：

• 类型：布尔值
• 从: 2.1
• 要求：否
• 表达式：${linkXRef}
• 默认值：真

---

输出目录：

• 类型：java.io.File
• 从: 2.8
• 要求：是
• 默认值：${project.reporting.outputDirectory}

---

输出文件：

• 类型：java.io.File
• 从: 2.8
• 要求：否
• 表达式：${checkstyle.output.file}
• 默认值：${project.build.directory}/checkstyle-result.xml

---

输出文件格式：

• 类型：java.lang.String
• 从: 2.8
• 要求：否
• 表达式：${checkstyle.output.format}
• 默认值：xml

---

属性位置：

• 类型：java.lang.String
• 自：2.0-beta-2
• 要求：否
• 表达式：${checkstyle.properties.location}

---

属性扩展：

• 类型：java.lang.String
• 从: 2.8
• 要求：否

---

跳过：

• 类型：布尔值
• 从: 2.2
• 要求：否
• 表达式：${checkstyle.skip}
• 默认值：假

---

源目录：

• 类型：java.io.File
• 从: 2.8
• 要求：是
• 默认值：${project.build.sourceDirectory}

---

抑制文件表达式：

• 类型：java.lang.String
• 从: 2.1
• 要求：否
• 表达式：${checkstyle.suppression.expression}
• 默认：checkstyle.suppressions.file

---

抑制位置：

• 类型：java.lang.String
• 自：2.0-beta-2
• 要求：否
• 表达式：${checkstyle.suppressions.location}

---

测试源目录：

• 类型：java.io.File
• 从: 2.2
• 要求：否
• 默认值：${project.build.testSourceDirectory}

---

使用文件：

• 类型：java.io.File
• 从: 2.8
• 要求：否

---

外部参照位置：

• 类型：java.io.File
• 从: 2.8
• 要求：否
• 默认值：${project.reporting.outputDirectory}/xref