用法

以下示例描述了 Checkstyle 插件的基本用法。

生成 Checkstyle 报告作为项目报告的一部分

要生成 Checkstyle 报告作为项目报告的一部分，请在pom.xml的<reporting>部分添加 Checkstyle 插件。

<project>
  ...
  <reporting>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-checkstyle-plugin</artifactId>
        <version>2.10</version>
      </plugin>
    </plugins>
  </reporting>
  ...
</project>

然后，执行站点阶段以生成报告。

mvn site

独立生成 Checkstyle 报告

您还可以通过从命令行显式执行checkstyle:checkstyle目标来生成 Checkstyle 报告。除非您想使用特定配置，否则不需要在pom.xml中指定 Checkstyle 插件。

mvn checkstyle:checkstyle

配置 Checkstyle 插件

Maven 3

根据Maven 3 兼容性说明来配置 Checkstyle 插件，您需要将其添加到pom.xml的<build>部分，如下面的示例所示。

<project>
  ...
  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-checkstyle-plugin</artifactId>
        <version>2.10</version>
        <configuration>
          <enableRulesSummary>false</enableRulesSummary>
           ...
        </configuration>
      </plugin>
    </plugins>
  </build>
  ...
</project>

Maven 2

您可能需要在<build>部分和<reporting>部分之间复制一些配置细节，具体取决于您是使用 maven-checkstyle-plugin 作为构建的一部分、站点的一部分还是两者兼而有之。