1

I'm starting to use Static Code Analysis tools like Checkstyle, PMD and FindBugs. PMD allows to mark code as reviewed, by adding a comment to the end of the line:

System.out.println("Test"); // NOPMD by edward on 9/23/14 10:22 AM

I really don't like trailing comments and so does CheckStyle ("Don't use trailing comments."). Is there a way to tell PMD that a specific code is reviewed, without using trailing comments?

Edward
  • 4,453
  • 8
  • 44
  • 82

2 Answers2

3

Another way of tackling this could be to configure Checkstyle to make an exception from the TrailingComment rule for suppression comments like this:

<module name="TrailingComment">
    <property name="legalComment" value="^NOPMD .*"/>
</module>
barfuin
  • 16,865
  • 10
  • 85
  • 132
2

You can try to add @SuppressWarnings("PMD") to the class or method where you get the warning. However, this is not the best solution, because it will disable all warnings on the marked target. Here, you can read more about suppressing.

You could maybe try FaultHunter, which is very similar to PMD, and can suppress warnings by kind (e.g. @SuppressWarnings("FH.UnusedConstructor")) and even on method level.

Csuki
  • 1,297
  • 8
  • 21
  • PMD also has this feature, you can suppress rule violations via `@SuppressWarnings("PMD.RuleName")`, maybe back in the day this wasn't the case. It is still bad practice to use `@SuppressWarnings` instead of `// NOPMD` as a single line violation should affect the whole method (i.e. suppressing one violation is what you want, but not all future violations of the same kind). – TWiStErRob Dec 26 '17 at 17:09