1、引入包的要求(import)
a、引入类时必需写全类的完整路径,即不能使用*导入所需的类
b、不能导入没有使用的类
2、代码注释
ps:类、成员变量、常量、方法函数都必须使用javadoc格式注释
a、类注释
标注作者:必须是汉字,最多5个字符
b、方法函数注释(包含参数名与返回值得注释)
c、成员变量、常量注释
3、命名规范
a、包名规范:首字母小写,可包含数字,不能用下划线
b、常量规范:static需要写在final前面,字母必须大写,用下划线分割,可以包含数字,字符长度1-40
c、静态变量规范(static,non-final fields)首字母小写,驼峰标示,不能用下划线,字符长度1-25
d、成员变量规范:首字母小写,驼峰标示,可用下划线(model类适配前端),字符长度1-25
e、参数名规范:首字母小写,驼峰标示,可用下划线(model类适配前端),字符长度1-25
f、方法名规范:首字母小写,驼峰标示,不能用下划线,字符长度1-25
4、其他代码规范
a、方法的左大括号“{”代码同一行显示,右大括号“}”需新建一行
b、代码需要缩进
c、每行只能定义一个变量
d、数组定义采用java风格,即:int[] num;非:int num[];
e、TODO是javaIDE自动生成的。一般代码写完后要去掉。
f、一个文件类的代码行数不能超过2500行,一个方法不能超过300行,一行不能超过200个字符
g、如果是工具类,里面全是static方法,请写一个private的构造函数,避免外部new
h、long类型赋值时如果有加大写’L’,不要用小写’l’,因为与数字1相似(例如:100L)
i、switch必须要有default
j、switch中case后需要加入了跳出语句,例如:return、break、throw、continue
k、构造方法的参数不能超过10个,方法参数不能超过10个
m、if-else嵌套语句个数 最多4层
l、try-catch 嵌套语句个数 最多2层
n、一个方法的return不能超过5个
o、boolean值不能有冗余 比如if (b == true), b || true, !false
p、检查是否存在过度复杂的boolean返回值
q、只有私有构造器的类必须声明为final
r、interface方法不要用public、abstract修复
s、字符串比较必须使用equals(),而不是==
t、检查在重写了equals方法后是否重写了hashCode方法
u、成员变量用private修饰并提供get set方法给外部使用,不可直接用public修饰
总结:在save代码之前,请先格式化代码,eclipse快捷键 ctrl+shirt+F,android studio快捷键ctrl+opt+L
5、checkstyle配置
android studio:
1、插件安装
2、配置checkstyle.xml文件
3、检测代码
eclipse、myEclipse自行百度