插件文档

此插件可用的目标:

目标 报告? 描述
检查样式:检查 执行 Checkstyle 分析并将违规或违规计数输出到控制台,可能会导致构建失败。它也可以配置为重新使用早期的分析。
检查样式:检查样式 是的 执行 Checkstyle 分析并针对 Checkstyle 发现的任何违规生成 HTML 报告的报告任务。
checkstyle:checkstyle-聚合 是的 执行 Checkstyle 分析并生成关于 Checkstyle 在多模块反应器构建中发现的违规的聚合 HTML 报告的报告任务。
检查样式:帮助 显示有关 maven-checkstyle-plugin 的帮助信息。
调用mvn checkstyle:help -Ddetail=true -Dgoal=<goal-name>以显示参数详细信息。

系统要求

以下指定了运行此 Maven 插件的最低要求:

maven 3.0
JDK 1.8
记忆 没有最低要求。
磁盘空间 没有最低要求。

用法

您应该在项目的插件配置中指定版本:

<project>
  ...
  <build>
    <!-- To define the plugin version in your parent POM -->
    <pluginManagement>
      <plugins>
        <plugin>
          <groupId>org.apache.maven.plugins</groupId>
          <artifactId>maven-checkstyle-plugin</artifactId>
          <version>3.1.2</version>
        </plugin>
        ...
      </plugins>
    </pluginManagement>
    <!-- To use the plugin goals in your POM or parent POM -->
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-checkstyle-plugin</artifactId>
        <version>3.1.2</version>
      </plugin>
      ...
    </plugins>
  </build>
  ...
  <!-- To use the report goals in your POM or parent POM -->
  <reporting>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-checkstyle-plugin</artifactId>
        <version>3.1.2</version>
      </plugin>
      ...
    </plugins>
  </reporting>
  ...
</project>

有关详细信息,请参阅“配置插件指南”