PMD / CPD：使用注释忽略代码位

Question

有没有办法告诉PMD忽略检查部分代码是否有重复？

例如，我可以这样做：

// CPD-Ignore-On
...
// CPD-Ignore-Off

目前我使用Maven设置这样的PMD，但是除非我遗漏了什么，否则看不到任何想让我做我想做的事情。

        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-pmd-plugin</artifactId>
            <version>2.5</version>
            <configuration>
                <minimumTokens>40</minimumTokens>
                <targetJdk>1.5</targetJdk>
                <ignoreIdentifiers>true</ignoreIdentifiers>
                <ignoreLiterals>true</ignoreLiterals>
            </configuration>
        </plugin>

Answer 1

经过深入挖掘后，我终于遇到了它。

通过添加注释@SuppressWarnings("CPD-START")和@SuppressWarnings("CPD-END")，CPD将忽略其中的所有代码 - 因此您可以避免误报。

来源 - http://pmd.sourceforge.net/pmd-5.0.5/cpd-usage.html。

Answer 2

我发现只有在项目pom中禁用maven-pmd-plugin配置中的全班检查才有可能。它是通过添加<excludes>标签来执行的。如果你想这样做，你的conf应该是这样的：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-pmd-plugin</artifactId>
    <version>2.5</version>
    <configuration>
        <minimumTokens>40</minimumTokens>
        <targetJdk>1.5</targetJdk>
        <ignoreIdentifiers>true</ignoreIdentifiers>
        <ignoreLiterals>true</ignoreLiterals>
        <excludes>
            <exclude>**/YourClassName.java</exclude>
            ........
            <exclude>....</exclude>
        </excludes>
    </configuration>
</plugin>

Answer 3

我知道这是一个8年前的问题，但为了完整起见，CPD确实支持这个PMD 5.6。0（2017年4月）。

有关基于评论的抑制的完整（当前）文档可在https://pmd.github.io/pmd-6.13.0/pmd_userdocs_cpd.html#suppression获得

值得注意的是，如果文件有// CPD-OFF注释，但没有匹配的// CPD-ON，一切都将被忽略，直到文件结束。