命名风格
代码中的命名不能以下划线以及美元符号开始,也不能以下划线与美元符号结束.
变量避免使用拼音,有歧义.
类名使用UpperCamelCase风格,DO、BO、DTO、VO、AO、PO、UID除外。
JavaServerlessPlatform / UserDO / XmlService / TcpUdpDeal / TaPromotion
- 方法名、参数名、成员变量、局部变量使用lowerCamelCase风格.
localValue / getHttpMessage() / inputUserId
- 常量命名全部大写,以下划线分隔,力求语义表达完整清楚,不可因为长度而省略关键信息.
正例:MAX_STOCK_COUNT / CACHE_EXPIRED_TIME
反例:MAX_COUNT / EXPIRED_TIME
抽象类命名使用Abstart或者Base开头;异常类命名使用Expetion结尾;测试类命名以它要测试的类的名称开始,以Test结尾.
POJO类中Boolean类型不要加is前缀,可能会引起序列化错误。
避免在子父类的成员变量之间、或者不同代码块的局部变量之间采用完全相同的命名,使可读性降低。
任何编程元素在命名时,应该使用完整的单词组合来表达其意。
在常量与变量的命名时,表示类型的名词放在词尾,以提升辨识度。
如果使用了设计模式,在命名时需要体现。
正例: public class OrderFactory;
public class LoginProxy;
public class ResourceObserver;
- 枚举类名带上Enum后缀,枚举成员名称需要大写,单词用下划线隔开。
Spring系列遇上过年,不能继续更新。分享一下读阿里巴巴规范手册的笔记。[doge]