注意：这个目标应该用作 Maven 报告。
全名：
org.apache.maven.plugins:maven-checkstyle-plugin:2.11:checkstyle
说明：
属性：
| 姓名 | 类型 | 自从 | 描述 |
|---|---|---|---|
| 包括资源 | 布尔值 | 2.11 | 指定是否在检查中包括资源目录。 默认值为：true。 用户属性是：checkstyle.includeResources。 |
| 包括测试资源 | 布尔值 | 2.11 | 指定是否在检查中包括测试资源目录。 默认值为：true。 用户属性是：checkstyle.includeTestResources。 |
| 包括 | 细绳 | 2.8 | 指定要用于 Checkstyle 的源文件的名称过滤器。注意：默认值为
**\/*.java。 默认值为：**\/*.java。 用户属性是：checkstyle.includes。 |
| 输出目录 | 文件 | 2.8 | 报告的输出目录。请注意，仅当直接从命令行运行目标时才会评估此参数。如果目标作为站点生成的一部分间接运行，则使用在 Maven 站点插件中配置的输出目录。 默认值为：${project.reporting.outputDirectory}。 |
| 资源包括 | 细绳 | 2.11 注意：默认值为 {@code **\/*.properties}。 | 指定要用于 Checkstyle 的源文件的名称过滤器。 默认值为：**/*.properties。 用户属性是：checkstyle.resourceIncludes。 |
| 源目录 | 文件 | 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。 用户属性是：checkstyle.config.location。 |
| 控制台输出 | 布尔值 | 2.8 | 将错误输出到控制台。 默认值为：false。 |
| enableFiles总结 | 布尔值 | 2.8 | 指定是否应启用文件摘要。 默认值为：true。 用户属性是：checkstyle.enable.files.summary。 |
| 启用RSS | 布尔值 | 2.8 | 指定是否应启用 RSS。 默认值为：true。 用户属性是：checkstyle.enable.rss。 |
| enableRules总结 | 布尔值 | 2.8 | 指定是否应启用规则摘要。 默认值为：true。 用户属性是：checkstyle.enable.rules.summary。 |
| enableSeveritySummary | 布尔值 | 2.8 | 指定是否应启用严重性摘要。 默认值为：true。 用户属性是：checkstyle.enable.severity.summary。 |
| 编码 | 细绳 | 2.2 | 读取源文件时使用的文件编码。如果未设置属性project.build.sourceEncoding，则使用平台默认编码。注意：此参数始终覆盖Checkstyle 的TreeWalker模块中的属性字符集。默认值为：${project.build.sourceEncoding}。用户属性是：编码。 |
| 排除 | 细绳 | 2.8 | 指定要为 Checkstyle 排除的源文件的名称过滤器。 用户属性是：checkstyle.excludes。 |
| 失败错误 | 布尔值 | 2.8 | 指定构建是否应因违规而失败。 默认值为：false。 |
| 格式 | 细绳 | 2.8 | 已弃用。请改用 configLocation。 默认值为：太阳。 |
| 头文件 | 文件 | 2.8 | 已弃用。请改用 headerLocation。 默认值为：${basedir}/LICENSE.txt。 |
| 标头位置 | 细绳 | 2.0-beta-2 | 指定 Checkstyle 可以使用的许可证文件（也称为头文件）的位置，以验证源代码是否具有正确的许可证头。 您需要在 Checkstyle xml 配置中使用 ${checkstyle.header.file} 来引用此头文件的名称。 例如： <module name="RegexpHeader"> <property name="headerFile" value="${checkstyle.header.file}"/> </module> 默认值为：LICENSE.txt。 用户属性是：checkstyle.header.file。 |
| 包括TestSourceDirectory | 布尔值 | 2.2 | 包含或不包含用于 Checkstyle 的测试源目录。 默认值为：false。 |
| 链接外部参照 | 布尔值 | 2.1 | 将违规行号链接到源外部参照。如果正在使用 Maven JXR 插件，将自动链接。 默认值为：true。 用户属性是：linkXRef。 |
| 输出文件 | 文件 | 2.8 | 指定保存 checkstyle 输出的路径和文件名。输出文件的格式由
outputFileFormat参数确定。 默认值为：${project.build.directory}/checkstyle-result.xml。 用户属性是：checkstyle.output.file。 |
| 输出文件格式 | 细绳 | 2.8 | 指定写入输出文件时要使用的输出格式。有效值为“plain”和“xml”。 默认值为：xml。 用户属性是：checkstyle.output.format。 |
| 包名文件 | 细绳 | 2.8 | 已弃用。请改用 packageNamesLocation。 |
| 包名称位置 | 细绳 | 2.0-beta-2 | 指定用于配置 Checkstyle Packages的包名称 XML 的位置。 此参数被解析为资源、URL 和文件。如果解析为资源或 URL，则将包名称 XML 的内容复制到 ${project.build.directory}/checkstyle-packagenames.xml 文件中，然后再传递给 Checkstyle 进行加载。 |
| 属性文件 | 文件 | 2.8 | 已弃用。请改用 propertiesLocation。 |
| 属性位置 | 细绳 | 2.0-beta-2 | 指定属性文件的位置。 这个参数被解析为 URL，文件然后资源。如果成功解析，属性位置的内容将被复制到 ${project.build.directory}/checkstyle-checker.properties 文件中，然后再传递给 Checkstyle 进行加载。 propertiesLocation的内容将提供给 Checkstyle 用于指定 xml 配置中的参数值（在configLocation 参数中指定）。 用户属性是：checkstyle.properties.location。 |
| 属性URL | 网址 | 2.8 | 已弃用。请改用 propertiesLocation。 |
| 财产扩张 | 细绳 | 2.8 | 允许指定原始属性扩展信息。 |
| 资源排除 | 细绳 | 2.11 | 指定要为 Checkstyle 排除的源文件的名称过滤器。 用户属性是：checkstyle.resourceExcludes。 |
| 跳过 | 布尔值 | 2.2 | 跳过整个检查。 默认值为：false。 用户属性是：checkstyle.skip。 |
| 抑制文件 | 细绳 | 2.8 | 已弃用。改为使用抑制位置。 |
| 抑制文件表达式 | 细绳 | 2.1 | 要在抑制文件的属性中使用的键。 默认值为：checkstyle.suppressions.file。 用户属性是：checkstyle.suppression.expression。 |
| 抑制位置 | 细绳 | 2.0-beta-2 | 指定要使用的抑制 XML 文件的位置。 此参数被解析为资源、URL 和文件。如果成功解决，则将抑制 XML 的内容复制到 ${project.build.directory}/checkstyle-supressions.xml 文件中，然后再传递给 Checkstyle 进行加载。 有关将可用于您的 checkstyle 配置的属性，请参阅suppresssFileExpression 。 用户属性是：checkstyle.suppressions.location。 |
| 测试源目录 | 文件 | 2.2 | 指定要用于 Checkstyle 的测试源目录的位置。 默认值为：${project.build.testSourceDirectory}。 |
| 树行者名称 | 列表 | 2.11 | 使用自定义 treeWalker 时，请在此处指定它们的名称，以便 treeWalker 内部的检查最终成为规则摘要 |
| 使用文件 | 文件 | 2.8 | 如果为null，Checkstyle 插件将在标准输出上显示违规。否则，将创建一个包含违规的文本文件。 |
| 外部参照位置 | 文件 | 2.8 | 要链接到的外部参照的位置。 默认值为：${project.reporting.outputDirectory}/xref。 |
缓存文件：
配置位置：
指定要使用的 XML 配置的位置。
潜在值是文件系统路径、URL 或类路径资源。此参数期望位置的内容符合规则集的 xml 格式（Checkstyle Checker 模块）配置。
此参数被解析为资源、URL 和文件。如果成功解析，配置的内容将被复制到 ${project.build.directory}/checkstyle-configuration.xml 文件中，然后作为配置传递给 Checkstyle。
有 4 个预定义的规则集。
编码：
不包括：
失败错误：
格式：
头文件：
标头位置：
指定 Checkstyle 可以使用的许可证文件（也称为头文件）的位置，以验证源代码是否具有正确的许可证头。
您需要在 Checkstyle xml 配置中使用 ${checkstyle.header.file} 来引用此头文件的名称。
例如：
<module name="RegexpHeader"> <property name="headerFile" value="${checkstyle.header.file}"/> </module>
包括资源：
包括：
输出目录：
输出文件：
包名文件：
包名位置：
指定用于配置 Checkstyle Packages的包名称 XML 的位置。
此参数被解析为资源、URL 和文件。如果解析为资源或 URL，则将包名称 XML 的内容复制到 ${project.build.directory}/checkstyle-packagenames.xml 文件中，然后再传递给 Checkstyle 进行加载。
属性文件：
属性位置：
指定属性文件的位置。
这个参数被解析为 URL，文件然后资源。如果成功解析，属性位置的内容将被复制到 ${project.build.directory}/checkstyle-checker.properties 文件中，然后再传递给 Checkstyle 进行加载。
propertiesLocation的内容将提供给 Checkstyle 用于指定 xml 配置中的参数值（在configLocation 参数中指定）。
属性网址：
属性扩展：
资源排除：
资源包括：
跳过：
源目录：
抑制文件：
抑制位置：
指定要使用的抑制 XML 文件的位置。
此参数被解析为资源、URL 和文件。如果成功解决，则将抑制 XML 的内容复制到 ${project.build.directory}/checkstyle-supressions.xml 文件中，然后再传递给 Checkstyle 进行加载。
有关将可用于您的 checkstyle 配置的属性，请参阅suppresssFileExpression 。
使用文件：
