SuppressWithNearbyComment
Róbert Kohányi <[email protected]> Mon, 11 Jul 2011 19:21:44 +0200
| Newsgroups | gmane.comp.java.audit.checkstyle.user |
|---|---|
| Message-ID | <CABFab9fH65S=PrSPKmvZTMLvo9S2kKhzwhWKGgmr97GbxQiTCA@mail.gmail.com> |
I'm using the latest Checkstyle Eclipse (Indigo) plugin (5.3.0.201012121300)
and I can't seem to get to work the SuppressWithNearbyComment check.
E.g. the following does not work as expected (Checkstyle labels this with a
warning in Eclipse):
// @do-not-checkstyle MagicNumber
int x = 234234;
My check looks like this:
<module name="SuppressWithNearbyCommentFilter">
<property name="commentFormat" value="@do-not-checkstyle (.*)"/>
<property name="checkFormat" value="$1"/>
</module>
I've tried different commentFormats, but nothing worked.
Also, the TreeWalker module has a FileContentsHolder child module.
(I've attached the actual checkstyle.xml I'm using.)
Any ideas?
Thanks in advance!
Regards,
Kohányi Róbert
------------------------------------------------------------------------------
All of the data generated in your IT infrastructure is seriously valuable.
Why? It contains a definitive record of application performance, security
threats, fraudulent activity, and more. Splunk takes this data and makes
sense of it. IT sense. And common sense.
http://p.sf.net/sfu/splunk-d2d-c2
_______________________________________________
Checkstyle-user mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/checkstyle-user
checkstyle.xml
(text/xml, 7.4 KB)
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.3//EN" "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
<!--
This configuration file was written by the eclipse-cs plugin configuration editor
-->
<!--
Checkstyle-Configuration: Java checkstyle.
Description:
Java checkstyle.
-->
<module name="Checker">
<property name="severity" value="warning"/>
<property name="localeCountry" value="US"/>
<property name="localeLanguage" value="en"/>
<property name="charset" value="UTF-8"/>
<module name="TreeWalker">
<module name="FileContentsHolder"/>
<module name="AnnotationUseStyle"/>
<module name="MissingDeprecated"/>
<module name="MissingOverride"/>
<module name="PackageAnnotation"/>
<module name="AbstractClassName"/>
<module name="ClassTypeParameterName"/>
<module name="ConstantName"/>
<module name="LocalFinalVariableName"/>
<module name="LocalVariableName"/>
<module name="MemberName"/>
<module name="MethodName"/>
<module name="MethodTypeParameterName"/>
<module name="PackageName">
<property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
</module>
<module name="ParameterName"/>
<module name="StaticVariableName"/>
<module name="TypeName"/>
<module name="ModifierOrder"/>
<module name="RedundantModifier"/>
<module name="AvoidNestedBlocks"/>
<module name="EmptyBlock"/>
<module name="AnonInnerLength">
<property name="max" value="10"/>
</module>
<module name="ExecutableStatementCount">
<property name="max" value="15"/>
<property name="tokens" value="INSTANCE_INIT,STATIC_INIT,METHOD_DEF,CTOR_DEF"/>
</module>
<module name="LineLength">
<property name="max" value="120"/>
<property name="tabWidth" value="2"/>
</module>
<module name="MethodLength">
<property name="max" value="15"/>
</module>
<module name="ParameterNumber">
<property name="max" value="3"/>
</module>
<module name="OuterTypeNumber"/>
<module name="MethodCount">
<property name="maxTotal" value="50"/>
<property name="maxPrivate" value="30"/>
<property name="maxPackage" value="30"/>
<property name="maxProtected" value="10"/>
<property name="maxPublic" value="10"/>
</module>
<module name="ArrayTypeStyle"/>
<module name="Indentation">
<property name="basicOffset" value="2"/>
<property name="caseIndent" value="2"/>
</module>
<module name="TrailingComment"/>
<module name="UncommentedMain"/>
<module name="UpperEll"/>
<module name="OuterTypeFilename"/>
<module name="JavadocMethod">
<property name="scope" value="protected"/>
<property name="allowUndeclaredRTE" value="true"/>
<property name="suppressLoadErrors" value="true"/>
</module>
<module name="JavadocStyle">
<property name="scope" value="protected"/>
</module>
<module name="JavadocType">
<property name="scope" value="protected"/>
</module>
<module name="JavadocVariable">
<property name="scope" value="protected"/>
</module>
<module name="IllegalImport"/>
<module name="RedundantImport"/>
<module name="UnusedImports"/>
<module name="GenericWhitespace"/>
<module name="EmptyForInitializerPad"/>
<module name="EmptyForIteratorPad"/>
<module name="NoWhitespaceAfter"/>
<module name="NoWhitespaceBefore"/>
<module name="OperatorWrap"/>
<module name="MethodParamPad"/>
<module name="ParenPad"/>
<module name="TypecastParenPad">
<property name="tokens" value="RPAREN,TYPECAST"/>
</module>
<module name="WhitespaceAfter"/>
<module name="WhitespaceAround">
<property name="allowEmptyConstructors" value="true"/>
<property name="allowEmptyMethods" value="true"/>
</module>
<module name="AvoidInlineConditionals"/>
<module name="CovariantEquals"/>
<module name="DefaultComesLast"/>
<module name="DeclarationOrder"/>
<module name="DoubleCheckedLocking"/>
<module name="EmptyStatement"/>
<module name="EqualsAvoidNull"/>
<module name="EqualsHashCode"/>
<module name="ExplicitInitialization"/>
<module name="FallThrough"/>
<module name="HiddenField">
<property name="tokens" value="VARIABLE_DEF"/>
<property name="ignoreConstructorParameter" value="true"/>
<property name="ignoreSetter" value="true"/>
</module>
<module name="IllegalInstantiation">
<property name="classes" value="java.lang.Boolean"/>
</module>
<module name="IllegalCatch"/>
<module name="IllegalThrows"/>
<module name="IllegalType">
<property name="tokens" value="METHOD_DEF,PARAMETER_DEF,VARIABLE_DEF"/>
</module>
<module name="InnerAssignment"/>
<module name="JUnitTestCase"/>
<module name="MagicNumber"/>
<module name="MissingCtor"/>
<module name="MissingSwitchDefault"/>
<module name="ModifiedControlVariable"/>
<module name="MultipleStringLiterals"/>
<module name="MultipleVariableDeclarations"/>
<module name="NestedForDepth"/>
<module name="NestedIfDepth"/>
<module name="NestedTryDepth"/>
<module name="NoClone"/>
<module name="NoFinalizer"/>
<module name="PackageDeclaration"/>
<module name="PackageDeclaration"/>
<module name="ParameterAssignment"/>
<module name="RedundantThrows">
<property name="suppressLoadErrors" value="true"/>
</module>
<module name="ReturnCount"/>
<module name="SimplifyBooleanExpression"/>
<module name="SimplifyBooleanReturn"/>
<module name="StringLiteralEquality"/>
<module name="SuperClone"/>
<module name="SuperFinalize"/>
<module name="UnnecessaryParentheses"/>
<module name="OneStatementPerLine"/>
<module name="BooleanExpressionComplexity"/>
<module name="ClassDataAbstractionCoupling">
<property name="max" value="3"/>
</module>
<module name="ClassFanOutComplexity">
<property name="max" value="10"/>
</module>
<module name="CyclomaticComplexity">
<property name="max" value="4"/>
</module>
<module name="JavaNCSS">
<property name="methodMaximum" value="30"/>
<property name="classMaximum" value="500"/>
<property name="fileMaximum" value="1000"/>
</module>
<module name="NPathComplexity"/>
<module name="DesignForExtension"/>
<module name="FinalClass"/>
<module name="InnerTypeLast"/>
<module name="HideUtilityClassConstructor"/>
<module name="InterfaceIsType"/>
<module name="MutableException"/>
<module name="ThrowsCount"/>
<module name="VisibilityModifier">
<property name="packageAllowed" value="true"/>
<property name="protectedAllowed" value="true"/>
</module>
</module>
<module name="JavadocPackage"/>
<module name="FileLength">
<property name="max" value="500"/>
</module>
<module name="SuppressionCommentFilter">
<property name="offCommentFormat" value="@checkstyle:off (.*)"/>
<property name="onCommentFormat" value="@checkstyle:on (.*)"/>
<property name="checkFormat" value="$1"/>
</module>
<module name="NewlineAtEndOfFile">
<property name="lineSeparator" value="lf"/>
</module>
<module name="FileTabCharacter"/>
<module name="StrictDuplicateCode"/>
<module name="SuppressWithNearbyCommentFilter">
<property name="commentFormat" value="@do-not-checkstyle (.*)"/>
<property name="checkFormat" value="$1"/>
</module>
</module>