目录
- 1. 项目名全部小写
- 2. 包名全部小写
- 3. 类名使用UpperCamelCase风格,必须遵从驼峰形式,但以下情形列外:DO / BO / DTO / VO / AO**
- 4. 方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase风格,必须遵从驼峰形式。**
- 5. 常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不需要嫌名字长。**
- 6. 抽象类命名使用Abstract或Base开头;异常类命名使用Exception结尾;测试类命名以它要测试的类的名称开始,以Test结尾。
- 7. 类型与中括号紧挨相连来表示数组。
- 8. POJO类中布尔类型变量都不要加is前缀,否则部分框架解析会引起序列化错误
- 9. 完整的单词组合
| JAVA开发手册
1. 项目名全部小写
- 代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。
- 代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。
2. 包名全部小写
包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式,但是类名如果有复数含义,类名可以使用复数形式。
正例:应用工具类包名为com.alibaba.ai.util、类名为MessageUtils(此规则参考spring的框架结构)
3. 类名使用UpperCamelCase风格,必须遵从驼峰形式,但以下情形列外:DO / BO / DTO / VO / AO**
正例:MarcoPolo / UserDO / XmlService / TcpUdpDeal
反例:marcoPolo / UserDo / XMLService / TCPUDPDeal
4. 方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase风格,必须遵从驼峰形式。**
正例:localValue / getHttpMessage() / inputUserId
5. 常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不需要嫌名字长。**
正例:MAX_STOCK_COUNT
反例:MAX_COUNT
6. 抽象类命名使用Abstract或Base开头;异常类命名使用Exception结尾;测试类命名以它要测试的类的名称开始,以Test结尾。
7. 类型与中括号紧挨相连来表示数组。
正例:定义整形数组int[] arrayDemo;
反例:在main参数中,使用String args[]来定义。
8. POJO类中布尔类型变量都不要加is前缀,否则部分框架解析会引起序列化错误
9. 完整的单词组合
为了达到代码自解释的目标,任何自定义编程元素在命名时,使用尽量完整的单词组合来表达其意。
正例:在JDK中,表达原子更新的类名为:AtomicReferenceFieldUpdater。
反例:int a的随意命名方式。