Checkstyle - 检查重复时忽略Javadoc

时间:2014-12-16 15:42:18

标签: java checkstyle

我使用checkstyle检查代码中的违规行为。我配置中的一个模块是关于重复代码。由于我使用的是StrictDuplicateCode,因此我也会违反javaDoc的重复。

任何人都可以指导我实现目标吗?

与此同时,我尝试了以下但是它不起作用:

为了抑制与java doc的重复,我创建了一个单独的xml文件(JavaDocSup.xml),其中包含以下内容

   <?xml version="1.0"?>
    <!DOCTYPE suppressions PUBLIC
    "-//Puppy Crawl//DTD Suppressions 1.1//EN"
    "http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">
    <suppressions>
    <suppress checks="JavadocStyleCheck"
              files="SomeClass.java"
    />
    </suppressions>

然后我在主配置文件中添加了以下代码。以下是我的配置文件的代码。

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

    <module name="Checker">
      <property name="severity" value="warning"/>
      <module name="TreeWalker">
        <module name="MethodLength">
          <property name="max" value="50"/>
       </module>
    <module name="ParameterNumber">
      <property name="max" value="4"/>
    </module>
    <module name="CyclomaticComplexity"/>
     </module>
  <module name="StrictDuplicateCode">
    <property name="fileExtensions" value="java"/>
  </module>
   <module name="SuppressionFilter">
    <property name="file" value="${samedir}/JavaDocSup.xml"/>
  </module>
</module>

当我在代码上运行checkstyle时,它仍会检测Java doc中的重复行。 抑制检查=&#34; JavadocStyleCheck“是否正确? 任何帮助将受到高度赞赏。谢谢。

1 个答案:

答案 0 :(得分:0)

Checkstyle的 StrictDuplicateCode 被发现效率低下,因此它thrown away(自Checkstyle 6.2起)。尝试使用PMD&#39; s CPD等其他工具

如果您想坚持使用当前的Checkstyle版本,只有至少有20行匹配时,您才可以尝试添加<property name="min" value="20"/>来抛出违规行为。

Wikipedia

中的工具部分提到了一些克隆检测工具