(一)命名风格
1. 命名不能以下划线开始,也不能以下划线结束。
2. 命名严禁使用拼音与英文混合的方式,更不允许使用中文。
但是:alibaba / taobao hangzhou 等国际通用的名称,可视同英文。
3. 类名使用 大驼峰风格,必须遵从驼峰形式。即每个单词首字母大写。类名如果有复数含义,类名可以使用复数形式。
4. 方法名、参数名、成员变量、局部变量用小驼峰风格,必须遵从驼峰形式。即首单词首字母小写,后面单词首字母大写。
5. 常量命名全部大写,单词之间用下划线隔开,要词义准确。
6. 抽象类命名使用 Abstract 或 Base 开头;
异常类命名使用 Exception 结尾;
测试类命名以它要测试的类的名称开始,以 Test 结尾。
7. 包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式。
8. 枚举类名建议带上 Enum 后缀,枚举成员名称需要全大写,单词间用下划线隔开。说明:枚举其实就是特殊的常量类,且构造方法被默认强制是私有。
正例:枚举名字为 ProcessStatusEnum 的成员名称:SUCCESS / UNKOWN_REASON。
9.
1) 获取单个对象的方法用 get 做前缀。
2) 获取多个对象的方法用 list 做前缀。
3) 获取统计值的方法用 count 做前缀。
4) 插入的方法用 save/insert 做前缀。
5) 删除的方法用 remove/delete 做前缀。
6)修改的方法用 update 做前缀。
(二)常量定义
1. 不允许未经定义的常量直接出现在代码中。
2. long 初始赋值时,使用大写的 L,不能是小写的 l,小写容易跟数字 1 混淆。
3. 不要使用一个常量类维护所有常量,按常量功能进行归类,分开维护。
4. 如果变量值仅在一个范围内变化,且带有名称之外的延伸属性,定义为枚举类。
下面正例中的数字就是延伸信息,表示星期几。
public Enum { MONDAY(1), TUESDAY(2), WEDNESDAY(3), THURSDAY(4), FRIDAY(5), SATURDAY(6), SUNDAY(7);}