一、命名风格:
1、【强制】类名使用UpperCameCase风格,必须遵从驼峰形式,但以下情形例外:DO/BO/DTO/VO/AO
正例:UserDO
反例:UserDo
2、【强制】常量命名全部大写,单词间用下划线隔开,力求语义完整表达清楚,不要嫌名字长。
正例:MAX_STOCK_COUNT
反例:MAX_COUNT
3、【强制】抽象类命名使用Abstract或者Base开头;异常类命名使用Exception结尾;测试类命名以他要测试的类的名称开始,以Test结尾。
4、【强制】数组定义:String [] args;
5、【强制】POJO类中布尔类型的变量,都不要加is,否则部分框架解析会引起序列化错误。
6、【强制】包名统一使用小写,点分隔符之间有且仅有一个自然语义的英文单词。包名统一使用单数形式,但是类名如果有复数含义,类名可以使用复数形式。
7、【强制】如果使用到了设计模式,建议在类名中体现出具体模式。说明:将设计模式体现在名字中,有利于阅读者快速理解架构设计思想。
正例:public class OrderFactory;
public class LoginProxy;
8、【推荐】接口类的方法和属性不要加任何修饰符号(public也不要加),保持代码的简洁性,并加上有效的Javadoc注释。尽量不要在接口里定义变量。如果一定要定义变量,肯定与接口方法有关,并且是整个应用的基础常量。
正例:接口方法名:void f();
接口基础常量表示:String COM