java checkStyle

2019独角兽企业重金招聘Python工程师标准>>>

http://blog.youkuaiyun.com/ccboy2009/article/details/32318781

1. template.xml配置如下：

<?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">

<module name="Checker">

<!--检查重复行-->
<module name="StrictDuplicateCode">
	<property name="min" value="5" />
</module>

<!--文件行数-->
<module name="FileLength">
	<property name="max" value="2000"/>
</module>

<module name="FileTabCharacter"/>

<module name="TreeWalker">
	
	<!--javadoc的检查:1类,2方法,3变量-->
	<module name="JavadocType" />
	<module name="JavadocMethod"/>
	<module name="JavadocVariable"/> 
	
	<!-- import方面的检查:1避免*,2没有被用到,3重复的,4基本类型 -->
	<module name="AvoidStarImport" />
	<module name="UnusedImports" />
	
	<!-- 命名规则检查:Class或Interface ^[A-Z][a-zA-Z0-9]*$-->
	<module name="TypeName" />
	
	<!-- 方法名  ^[a-z][a-zA-Z0-9]*$-->
	<module name="MethodName" />
	
	<!-- 方法的参数命名 ^[a-z][a-zA-Z0-9]*$-->
	<module name="ParameterName " />
	
	<!-- 非static型变量  ^[a-z][a-zA-Z0-9]*$-->
	<module name="MemberName"/>
	
	<!-- 常量名检查(static , final 字段)  ^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$-->
	<module name="ConstantName" />
	
	<!-- 包名检查 ^[a-z]+(\.[a-z][a-z0-9]*)*$ -->
	<module name="PackageName">
		<property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
	</module>
	
	<!-- 局部的final变量，包括catch中的参数  ^[a-z][a-zA-Z0-9]*$ -->
	<module name="LocalFinalVariableName" />
	
	<!-- 局部的非final型的变量，包括catch中的参数  ^[a-z][a-zA-Z0-9]*$ -->
	<module name="LocalVariableName" />
	
	<!-- 仅仅是static型的变量（不包括staticfinal型）  ^[a-z][a-zA-Z0-9]*$ -->
	<module name="StaticVariableName" />


	<!-- 方法的参数个数不超过5个,并且不对构造方法进行检查-->
	<module name="ParameterNumber">
		<property name="max" value="5" />
		<property name="tokens" value="METHOD_DEF" />
	</module>


	<!--代码行数及行代码长度限制: 方法不超过200行,每行不超过150字符-->
	<module name="MethodLength">
		<property name="tokens" value="METHOD_DEF" />
		<property name="max" value="200" />
	</module>
	<module name="LineLength">
		<property name="max" value="150" />
	</module>

	<!-- 空格限定-->
	<module name="MethodParamPad"/>
	<module name="ParenPad"/>
	<module name="TypecastParenPad"/>

	
	<!-- 关键字-->
	<!-- public static final XXX 是对一个常量的声明。如果使用static public final 就是错误的 -->
	<module name="ModifierOrder"/>
	<!-- 过滤多于的关键字-->
	<module name="RedundantModifier"/>
	
	<!-- 空白域-->
	<module name="EmptyBlock"/>
	<module name="NeedBraces"/>
	<!-- 多余的括号 -->
	<module name="AvoidNestedBlocks">
		<property name= "allowInSwitchCase" value="true"/>
	</module>
	
	
	<!--编码方面的检查 -->
	<module name="EmptyStatement" />
	
	<!-- 如果某个变量一直都没变，那么它就应该是final型的
	<module name="FinalLocalVariable"/> -->
	
	<!-- 不允许使用switch语句 -->
	<module name="IllegalToken">
		<property name="tokens" value="LITERAL_SWITCH"/>
	</module>
	
	<!-- 内部赋值语句 ：String s = Integer.toString(i = 2); -->
	<module name="InnerAssignment"/>
	
	<!-- 绝对不能容忍魔法数 ，即数据标识常量化-->
	<module name="MagicNumber" />
	
	<!--循环控制变量-->
	<module name="ModifiedControlVariable" />
	
	<!-- 多余的throw -->
	<module name="RedundantThrows" />

	<!-- 未被简化的布尔返回值-->
	<module name="SimplifyBooleanReturn"/>
	<!-- String的比较不能用!= 和 == -->
	<module name="StringLiteralEquality" />
	
	<!-- if最多嵌套3层 -->
	<module name="NestedIfDepth">
		<property name="max" value="3" />
	</module>
	
	<!-- try最多被嵌套2层 -->
	<module name="NestedTryDepth">
		<property name="max" value="2" />
	</module>
	
	<!-- 检查并确认一个类的clone()方法调用了父类的clone() -->
	<module name="SuperClone"/>
	<!-- 检查并确认一个类的finalize()调用了父类的finalize() -->
	<module name="SuperFinalize"/>
	
	<!-- 不能catch java.lang.Exception,异常分类处理-->
	<module name="IllegalCatch">
		<property name="illegalClassNames" value="java.lang.Exception" />
	</module>
	 
	<!-- 确保一个类有package声明 -->
	<module name="PackageDeclaration" />
	
	<!-- 一个方法中最多有3个return -->
	<module name="ReturnCount">
		<property name="max" value="3" />
		<property name="format" value="^$" />
	</module>
	
	<!-- 确保某个class 在被使用时都已经被初始化成默认值(对象是null , 数字和字符是0 , boolean 变量是false.)了 -->
	<module name="ExplicitInitialization"/>
	
	<!-- 不许有同样内容的String -->
	<module name="MultipleStringLiterals" />
	
	<!-- 同一行不能有多个声明 -->
	<module name="MultipleVariableDeclarations" />
	
	<!-- 不必要的圆括号 检查不必要的圆括号”(,)”。比如， if(((((true))))) -->
	<module name="UnnecessaryParentheses" />		
	
	<!-- 限制一个布尔表达式中的 &&, || 和^的个数。可以让代码看起来更清晰，容易排错和维护  -->
	<module name="BooleanExpressionComplexity">
		<property name="max" value="4"/>
	</module>
	
	<!-- 一个类中如果使用太多其他的类，是肯定会增加系统复杂度的。使用其他的类越少，耦合度就越少 -->
	<module name="ClassDataAbstractionCoupling">
		<property name="max" value="10"/>
	</module>
	
	<!-- 确保函数的分支复杂度没有超出限制 -->
	<module name="CyclomaticComplexity">
		<property name="max" value="4"/>
	</module>
	
	<!-- NPATH 量度计算了一个函数的可执行的分支个数 -->
	<module name="NPathComplexity">
		<property name="max" value="3"/>
	</module>

	<!-- ************************其他*********************************** -->
	<!-- 检查并确保所有的常量中的L都是大写的。因为小写的字母l跟数字1太象了 -->
	<module name="UpperEll" />
	
	<!-- 检查数组类型的定义是String[] args，而不是String args[] -->
	<module name="ArrayTypeStyle" />
	
	<!-- 不许使用与代码同行的注释
	<module name="TrailingComment"/>
	 -->
	 
	<!-- 不许存在TO DO -->
	<module name="TodoComment" />
	
	<!-- 除了正常的程序入口之外，所有的main方法都应该被删掉或注释掉 -->
	<module name="UncommentedMain"/>
</module>

</module>

转载于:https://my.oschina.net/u/2611678/blog/861463