CheckStyle代码开发规范.docx

一、JavaDoc注释

添加类和接口的javadoc，指明该类的大体功能

添加方法javadoc，并且对参数进行说明

二、命名约定
检查范围
约束的值
package名
首字母小写，以小写字母，数字组成
类型(Class或Interface)名
首字母大写，以大写字母，小写字母，数字组成
方法名
首字母小写，以大写字母，小写字母，数字组成。
方法命名需要以动词开头。
public void addKeyAttribute(String attribute){}
如返回类型为boolean型，则用is开头
public boolean isLogin(String username);
方法中的参数名
首字母小写，以大写字母，小写字母，数字组成
常量(static , final 字段)
首字母大写，以大写字母，数字，下划线组成。
建议每个音节下划线分割，并且有static final资源。
private static final String KEY_MODEL_CODE=”code”
变量
首字母小写，以大写字母，小写字母，数字组成
三、Imports
1. import中避免星号"*"
避免出现import .*

以下几种import是没用/没意义的：
没有被用到。
重复的。
import 。
import 与该类在同一个package的。
四、长度限制
1. 文件长度
文件的行数不超过1500
2. 每行长度
一行的长度不超过120个字母
3. 方法长度
一个方法最多的行数为50行，不包括空白和注释
4. 方法的参数个数
方法的参数不超过5个
五、关键字
1. 关键字的出现顺序
每个关键字都有正确的出现顺序。比如 public static final XXX 是对一个常量的声明。如果使用 static public final 就是错误的。
六、对区域(empty block)的检查
1.  空白区域
只要是{} 包含起来的，都是区域。比如if , else, catch 后面紧跟的，都是区域。不允许后面有空格，减少文件大小
2. 需要括号的区域
比如，只有一条语句的 if ，对于大括号是可用可不用的
if(condition) a= 0;
应该用{}，养成良好的编码****惯
3. 不必要的括号
比如，这样的代码是可以通过编译，但是风格很差的：
public void guessTheOutput()
{
int whichIsWich = 0;
{
int whichIsWhich = 2;
}
("value = " + whichIsWhich);
}
七、编码的检查
1. 字符串(String)的比较
检查字符串的比较时没有使用 == 或!=。
2. 不合理的throws
方法抛出异常时，不要使用不能throws ，要明确抛出