Question

我已将myven检查样式报告插件包含在我的pom.xml文件中，如下所示

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

我正在使用eclipse进行开发，并从here获得了maven java编码约定。现在，如果我格式化我的所有代码，并运行mvn网站工具，它仍会报告检查样式错误。有什么方法可以格式化我的代码以传递我的代码中的所有检查样式错误？

修改我在项目的根目录中放置了一个检查样式suppressions.xml文件。这包含以下

<?xml version="1.0"?>

<!DOCTYPE suppressions PUBLIC
     "-//Puppy Crawl//DTD Suppressions 1.0//EN"
     "http://www.puppycrawl.com/dtds/suppressions_1_0.dtd">

<suppressions>
  <suppress checks="JavadocStyleCheck"
             files=*.java"
             lines="0-99999999"/>

</suppressions>

然后我在我的pom.xml文件中将其配置为

<reporting>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-checkstyle-plugin</artifactId>
                <version>2.10</version>
                <configuration>
                    <suppressionsLocation>
                        checkstyle-suppressions.xml
                    </suppressionsLocation>
                    <suppressionsFileExpression>
                        checkstyle.suppressions.file
                    </suppressionsFileExpression>
                </configuration>
            </plugin>
        </plugins>
    </reporting>

我希望在mvn网站生成期间跳过java doc checkstyle错误。但是我还在接受这个吗？我究竟做错了什么？

亲切的问候

Answer 1

Using a Suppressions Filter告诉我们

Checkstyle允许定义应禁止报告任何违规行为的文件列表及其行范围（称为suppressions filter）。

示例：checkstyle-suppressions.xml

<?xml version="1.0"?>

<!DOCTYPE suppressions PUBLIC
     "-//Puppy Crawl//DTD Suppressions 1.0//EN"
     "http://www.puppycrawl.com/dtds/suppressions_1_0.dtd">

<suppressions>
  <suppress checks="JavadocStyleCheck"
             files="GeneratedObject.java"
             lines="50-9999"/>
  <suppress checks="MagicNumberCheck"
             files="LegacyDatasetConvertor.java"
             lines="221,250-295"/>
</suppressions>

示例：pom.xml - 指定Checkstyle应使用的抑制过滤器。

<project>
  ...
  <reporting>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-checkstyle-plugin</artifactId>
        <version>2.10</version>
        <configuration>
          <configLocation>checkstyle.xml</configLocation>
          <suppressionsLocation>
            checkstyle-suppressions.xml
          </suppressionsLocation>
          <suppressionsFileExpression>
            checkstyle.suppressions.file
          </suppressionsFileExpression>
        </configuration>
      </plugin>
    </plugins>
  </reporting>
  ...
</project>

<强> EDITED

Using a Custom Checkstyle Checker Configuration

可以定义，然后通过URL，File或构建类路径资源引用进行引用。要引用自定义Checkstyle Checker配置，请使用configLocation参数。

Checkstyle插件附带4个预定义的Checkstyle配置定义，默认情况下会选择Sun Microsystems定义。

config / sun_checks.xml - Sun Microsystems定义（默认）。
config / maven_checks.xml - Maven开发定义。
config / turbine_checks.xml - 涡轮机开发定义。
config / avalon_checks.xml - Avalon开发定义。

我希望这可能有所帮助。

Maven编码样式

1 个答案:

示例：checkstyle-suppressions.xml

示例：pom.xml - 指定Checkstyle应使用的抑制过滤器。