【原創】checkstyle配置文件说明（checkstyle 3.5）

上面的内容已经全部包含在附件中，读者可以下载，作为手册察看。

一个checkstyle文件的例子：

<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
    "-//Puppy Crawl//DTD Check Configuration 1.2//EN"
    "http://www.puppycrawl.com/dtds/configuration_1_2.dtd">

<module name="Checker">
	<property name="basedir" value="${check.src}"/>
	<property name="localeCountry" value="CN"/>
	<property name="localeLanguage" value="cn"/>
	<metadata name="com.atlas-sw.eclipse" value="I like Sydney"/>
	<property name="severity" value="error"/>
	<module name="SuppressionFilter">
		<property name="file" value="${check.filter.file}"/>
	</module>
	<module name="PackageHtml">
		<property name="fileExtensions" value="java,properties"/>
	</module>
	<module name="Translation">
		<property name="severity" value="info"/>
	</module>
	<module name="StrictDuplicateCode">
		<property name="min" value="7"/>
		<property name="charset" value="UTF-8"/>
	</module>
	<module name="NewlineAtEndOfFile">
	</module>
	<module name="TreeWalker">
		<module name="AbstractClassName">
			<property name="format" value="^Abstract.*$|^.*Factory$"/>
		</module>
		<module name="ImportOrder">
			<property name="groups" value="java,javax"/>
			<property name="ordered" value="true"/>
			<property name="separated" value="true"/>
			<property name="caseSensitive" value="true"/>
		</module>
		<module name="ExecutableStatementCount">
			<property name="max" value="20"/>
			<property name="tokens" value="CTOR_DEF,METHOD_DEF,STATIC_INIT,INSTANCE_INIT"/>
		</module>
		<module name="AnonInnerLength">
			<property name="max" value="20"/>
		</module>
		<module name="EmptyForInitializerPad">
			<property name="option" value="space"/>
		</module>
		<module name="EmptyForIteratorPad">
			<property name="option" value="space"/>
		</module>
		<module name="MethodParamPad">
			<property name="allowLineBreaks" value="false"/>
			<property name="option" value="space"/>
			<property name="tokens" value="METHOD_DEF,CTOR_DEF"/>
		</module>
		<module name="NoWhitespaceAfter">
			<property name="allowLineBreaks" value="true"/>
		</module>
		<module name="NoWhitespaceBefore">
			<property name="allowLineBreaks" value="true"/>
		</module>
		<module name="TypecastParenPad">
			<property name="option" value="space"/>
		</module>
		<module name="ParenPad">
			<property name="option" value="nospace"/>
		</module>
		<module name="WhitespaceAfter">
			<property name="tokens" value="COMMA,SEMI,TYPECAST"/>
		</module>
		<module name="WhitespaceAround">
			<property name="tokens" value="ASSIGN"/>
		</module>
		<module name="ModifierOrder"/>
		<module name="RedundantModifier">
			<property name="tokens" value="METHOD_DEF,VARIABLE_DEF"/>
		</module>
		<module name="AvoidNestedBlocks">
			<property name="allowInSwitchCase" value="true"/>
		</module>
		<module name="MissingSwitchDefault"/>
		<module name="ModifiedControlVariable"/>
		<module name="RedundantThrows">
			<property name="allowUnchecked" value="true"/>
			<property name="allowSubclasses" value="true"/>
		</module>
		<module name="StringLiteralEquality"/>
		<module name="SuperClone"/>
		<module name="SuperFinalize"/>
		<module name="IllegalCatch"/>
		<module name="PackageDeclaration"/>
		<module name="ReturnCount">
			<property name="max" value="3"/>
		</module>
		<module name="DeclarationOrder"/>
		<module name="ParameterAssignment"/>
		<module name="DefaultComesLast"/>
		<module name="FallThrough"/>
		<module name="MultipleStringLiterals">
			<property name="allowedDuplicates" value="3"/>
		</module>
		<module name="MultipleVariableDeclarations"/>
		<module name="RequireThis">
			<property name="checkFields" value="false"/>
			<property name="checkMethods" value="false"/>
		</module>
		<module name="UnnecessaryParentheses"/>
		<module name="HideUtilityClassConstructor"/>
		<module name="ThrowsCount">
			<property name="max" value="7"/>
		</module>
		<module name="BooleanExpressionComplexity">
			<property name="max" value="7"/>
		</module>
		<module name="ClassDataAbstractionCoupling">
			<property name="max" value="7"/>
		</module>
		<module name="AvoidInlineConditionals"/>
		<module name="CovariantEquals"/>
		<module name="HiddenField">
		</module>
		<module name="InterfaceIsType">
			<property name="allowMarkerInterfaces" value="true"/>
		</module>
		<module name="UncommentedMain">
			<property name="excludedClasses" value="^$"/>
		</module>
		<module name="ArrayTypeStyle">
			<property name="javaStyle" value="true"/>
		</module>
		<module name="Indentation">
			<property name="basicOffset" value="4"/>
			<property name="braceAdjustment" value="0"/>
			<property name="caseIndent" value="4"/>
		</module>
		<module name="RequiredRegexp">
			<property name="format" value="^$"/>
		</module>
		<module name="usage.OneMethodPrivateField">
			<property name="ignoreFormat" value="^$"/>
		</module>
		<module name="usage.UnusedLocalVariable">
			<property name="ignoreFormat" value="^$"/>
		</module>
		<module name="usage.UnusedParameter">
			<property name="ignoreFormat" value="^$"/>
			<property name="ignoreCatch" value="true"/>
			<property name="ignoreNonLocal" value="false"/>
		</module>
		<module name="usage.UnusedPrivateField">
			<property name="ignoreFormat" value="^$"/>
		</module>
		<module name="usage.UnusedPrivateMethod">
			<property name="ignoreFormat" value="^$"/>
		</module>
		<property name="cacheFile" value="${checkstyle.dir}/cacheFile"/>
		<property name="fileExtensions" value="java,ejb,jpf"/>
		<property name="charset" value="UTF-8"/>
		<property name="tabWidth" value="4" />
		<module name="FileContentsHolder">
		</module>
		<module name="GenericIllegalRegexp">
			<property name="format" value="\s$"/>
			<property name="ignoreCase" value="true"/>
			<property name="ignoreComments" value="true"/>
			<property name="message" value="wrong used"/>
		</module>
		<module name="AvoidStarImport">
			<property name="excludes" value="java.io,java.util"/>
		</module>
		<module name="ConstantName">
			<property name="format" value="^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$"/>
		</module>
		<module name="EmptyBlock">
			<property name="option" value="stmt"/>
		</module>
		<module name="EqualsHashCode"/>
		<module name="FileLength">
			<property name="max" value="1000"/>
		</module>
		<module name="IllegalImport">
		</module>
		<module name="IllegalInstantiation"/>
		<module name="InnerAssignment"/>
		<module name="JavadocType">
			<property name="authorFormat" value="\S"/>
			<property name="scope" value="protected"/>
			<property name="versionFormat" value="\$Revision.*\$"/>
			<property name="excludeScope" value="public"/>
			<property name="tokens" value="CLASS_DEF,INTERFACE_DEF"/>
		</module>
		<module name="JavadocMethod">
			<property name="scope" value="private"/>
			<property name="allowMissingParamTags" value="false"/>
			<property name="allowMissingThrowsTags" value="false"/>
			<property name="allowMissingReturnTag" value="false"/>
			<property name="tokens" value="METHOD_DEF"/>
			<property name="allowUndeclaredRTE" value="true"/>
			<property name="allowThrowsTagsForSubclasses" value="true"/>
		</module>
		<module name="JavadocVariable">
			<property name="scope" value="private"/>
		</module>
		<module name="JavadocStyle">
			<property name="scope" value="public"/>
			<property name="checkFirstSentence" value="true"/>
			<property name="checkEmptyJavadoc" value="true"/>
			<property name="checkHtml" value="true"/>
		</module>
		<module name="LeftCurly">
			<property name="option" value="eol"/>
			<property name="maxLineLength" value="80"/>
			<property name="tokens" 
				value="CLASS_DEF,INTERFACE_DEF,METHOD_DEF,CTOR_DEF"/>
		</module>
		<module name="LineLength">
			<property name="max" value="80"/>
			<property name="ignorePattern" value="^ *\* *[^ ]+$"/>
		</module>
		<module name="LocalFinalVariableName">
			<property name="format" value="^[A_Z][A-Z0-9]*(_[A_Z0-9]+)*$"/>
		</module>
		<module name="LocalVariableName">
			<property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
		</module>
		<module name="MemberName">
			<property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
			<property name="applyToPublic" value="true"/>
			<property name="applyToProtected" value="true"/>
			<property name="applyToPackage" value="true"/>
			<property name="applyToPrivate" value="true"/>
		</module>
		<module name="MethodLength">
			<property name="max" value="100"/>
			<property name="countEmpty" value="true"/>
			<property name="tokens" value="METHOD_DEF"/>
		</module>
		<module name="MethodName">
			<property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
		</module>
		<module name="ModifierOrder"/>
		<module name="NeedBraces">
		</module>
		<module name="OperatorWrap">
			<property name="tokens" 
				value="ASSIGN, DIV, DIV_ASSIGN, PLUS_ASSIGN, MINUS, MINUS_ASSIGN, STAR, STAR_ASSIGN, MOD, MOD_ASSIGN, SR, SR_ASSIGN, BSR, BSR_ASSIGN, SL, SL_ASSIGN, BXOR, BXOR_ASSIGN, BOR, BOR_ASSIGN, BAND, BAND_ASSIGN,PLUS, QUESTION"/>
			<property name="option" value="eol"/>
		</module>
		<module name="PackageName">
			<property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
		</module>
		<module name="ParameterName">
			<property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
		</module>
		<module name="ParameterNumber">
			<property name="max" value="10"/>
			<property name="tokens" value="METHOD_DEF,CTOR_DEF"/>
		</module>
		<module name="RedundantImport"/>
		<module name="RedundantModifier"/>
		<module name="RightCurly">
			<property name="option" value="alone"/>
			<property name="tokens" value="LITERAL_TRY"/>
		</module>
		<module name="SimplifyBooleanExpression"/>
		<module name="SimplifyBooleanReturn"/>
		<module name="StaticVariableName">
			<property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
		</module>
		<module name="TypeName">
			<property name="format" value="^[A-Z][a-zA-Z0-9]*$"/>
			<property name="tokens" value="CLASS_DEF,INTERFACE_DEF"/>
		</module>
		<module name="UnusedImports"/>
		<module name="UpperEll"/>
		<module name="VisibilityModifier">
			<property name="packageAllowed" value="false"/>
			<property name="protectedAllowed" value="false"/>
			<property name="publicMemberPattern" value="^seriaVersionUID$"/>
		</module>
		<module name="WhitespaceAround"/>
		<module name="FinalClass"/>
		<module name="MissingSwitchDefault"/>
		<module name="Indentation">
			<property name="basicOffset" value="4"/>
			<property name="braceAdjustment" value="0"/>
			<property name="caseIndent" value="0"/>
		</module>
		<module name="ArrayTrailingComma"/>
		<module name="CyclomaticComplexity">
			<property name="severity" value="ignore"/>
		</module>
		<module name="NestedIfDepth">
			<property name="max" value="1"/>
		</module>
		<module name="NestedTryDepth">
			<property name="max" value="3"/>
		</module>
		<module name="ExplicitInitialization"/>
	</module>
</module>