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.
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
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With