Question

我有一个看起来像这样的checkstyle文件：

<?xml version="1.0"?>
  <!DOCTYPE module PUBLIC
    "-//Puppy Crawl//DTD Check Configuration 1.2//EN"
    "http://www.puppycrawl.com/dtds/configuration_1_2.dtd">

<module name="Checker">
  <module name="SuppressionFilter">
    <property name="file" value="./suppressions.xml"/>
  </module>

  <module name="FileTabCharacter">
    <property name="eachLine" value="true"/>
  </module>

  <module name="TreeWalker">
  ...
    <module name="JavadocMethod"/>
    <module name="JavadocType"/>
    <module name="JavadocVariable"/>
  ...
  </module>
</module>

还有一个看起来像这样的suppressions.xml：

<suppressions>
  <suppress checks="JavadocMethod" files="[/\\]src[/\\]test[/\\]java[/\\]"/>
  <suppress checks="JavadocType" files="[/\\]src[/\\]test[/\\]java[/\\]"/>
  <suppress checks="JavadocVariable" files="[/\\]src[/\\]test[/\\]java[/\\]"/>
</suppressions>

这在过去运行良好，禁用Javadoc检查测试目录中的任何文件。

但是，现在我们想要显示一个测试文件缺少javadoc的警告，而不是完全忽略它，但对于不在测试目录中的文件，我们仍希望仍然具有错误严重性。

我已经尝试过并且没有运气。有没有办法做到这一点？

Answer 1

是的，您可以更改不同文件组的严重性。（对于我来说，Javadoc问题的严重性严重程度似乎相当严厉。）

基本思想是将Checkstyle配置为同时生成两个严重性，然后禁止您不想要的那些。为此，请为您的支票id（仅为 JavadocMethod 示例，为了简洁起见）：

<module name="JavadocMethod">
    <property name="id" value="jmwarn"/>
    <property name="severity" value="warning"/>
</module>
<module name="JavadocMethod">
    <property name="id" value="jmerr"/>
    <property name="severity" value="error"/>
</module>

然后，在您的抑制文件中，您可以控制哪些文件的严重性：

<!DOCTYPE suppressions PUBLIC "-//Puppy Crawl//DTD Suppressions 1.1//EN"
    "http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">
<suppressions>
    <suppress files="[/\\]src[/\\]test[/\\]" id="jmerr" />
    <suppress files="[\\/]src[\\/]main[\\/]" id="jmwarn" />
</suppressions>

更改与模式匹配的文件的Checkstyle规则的严重性

1 个答案: