How can you suppress checkstyle checks within a block of code only for specific rules?

Question

Possible Duplicate:
How to disable a particular checkstyle rule for a particular line of code?

In turning off Checkstyle for a segment of code, is there a syntax that would suppress only specific checks.

So rather than just

// CHECKSTYLE:OFF
code
// CHECKSTYLE:ON

you could have something like

// CHECKSTYLE:OFF:RequireThis,
code
// CHECKSTYLE:ON

In cases where we are purposely making an exception to the style, it would be nice to be clearer what the exception case is.

Does marking a question as a duplicate not allow for posting a link to the supposed duplicate question? I would think that would be valuable information to the existing question asker who didn't find that other question when searching and to anyone else which finds this version and has the same problem. — Daniel Holmes, Jun 16 '17 at 18:30

score 8 · Accepted Answer · edited Jul 15 '16 at 18:37

8

Recommend reading the documentation on SuppressionCommentFilter (it is buried at bit) for lots of examples.

An example of how to do configure the filter is:

<module name="SuppressionCommentFilter">
    <property name="offCommentFormat" value="CSOFF\: ([\w\|]+)"/>
    <property name="onCommentFormat" value="CSON\: ([\w\|]+)"/>
    <property name="checkFormat" value="$1"/>
</module>

You can then use the following to turn off the RequireThis check for a block of code:

// CSOFF: RequireThis
... code
// CSON: RequireThis

edited Jul 15 '16 at 18:37

stkent

19,772
14
85
111

answered Feb 15 '11 at 11:18

Oliver

639
5
9

That's the piece I couldn't grasp from the docs. Thanks – Daniel Holmes Feb 16 '11 at 15:10

How can you suppress checkstyle checks within a block of code only for specific rules?

1 Answers1

Linked