PMD/CPD: Ignore bits of code using comments

Question

Is there a way to tell PMD to ignore checking parts of code for duplication?

For example, can I do something like this:

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

Currently I have PMD set up like this using Maven, but don't see any arguments that would like me do what I want unless I am missing something.

        <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>

score 32 · Answer 1 · answered Sep 05 '13 at 00:31

32

After digging around enough, I finally came across it.

By adding the annotations @SuppressWarnings("CPD-START") and @SuppressWarnings("CPD-END") all code within will be ignored by CPD - thus you can avoid false positives.

Source - http://pmd.sourceforge.net/pmd-5.0.5/cpd-usage.html.

answered Sep 05 '13 at 00:31

Avik

1,170
10
25

5

The problem with this approach is that you can't exclude a whole class from CPD. The end annotation needs something to target. – Snicolas Jun 18 '14 at 12:34
6

@Snicolas I bound `@SuppressWarnings("CPD-START")` to the class, omitted the end annotation, and it looks like the entire class got ignored. Not ideal, but it seems to work. – Gili May 06 '16 at 17:12
1

Comment based suppressions are supported since PMD 5.7.0 – Johnco Apr 17 '19 at 03:31
@SuppressWarnings("CPD-START") just this top of the class worked. and it skipped the cpd scan – Vishwas Shenoy Alevoor Dec 16 '21 at 21:45

Johnco · Answer 2 · 2019-04-17T03:38:06.387

9

I know this is a 8 years old question, but for completeness, CPD does support this since PMD 5.6.0 (April 2017).

The complete (current) docs for comment-based suppression are available at https://pmd.github.io/pmd-6.13.0/pmd_userdocs_cpd.html#suppression

It's worth noting, if a file has a // CPD-OFF comment, but no matching // CPD-ON, everything will be ignored until the end of file.

edited Apr 17 '19 at 03:38

answered Apr 17 '19 at 03:31

Johnco

4,037
4
34
43

score 2 · Answer 3 · answered Feb 28 '13 at 09:01

I found it possible only to disable a whole class check in maven-pmd-plugin configuration in project pom. It is performed by adding <excludes> tag. If you would like to do it, your conf should be like this:

<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>

score 0 · Answer 4 · answered Feb 24 '22 at 01:24

Is there a way to tell PMD to ignore checking parts of code for duplication?

For duplication, you have 3 options:

You can use @SuppressWarnings("CPD-START") and @SuppressWarnings("CPD-END") around the code you want to skip.
If you want to ignore a file from a specific line til EOF, using @SuppressWarnings("CPD-START") alone is enough.
And if you already have Suppressing annotations you can add CPD-START as explained in the docs, i.e. @SuppressWarnings({"PMD", "CPD-START"})

PMD/CPD: Ignore bits of code using comments

4 Answers4