命名规范

  1. 代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。
       _huiji/$huiji/huiji_/huiji$
       以上都是不合法的
    
  2. 代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。简单的来说就是不能用拼音,除非是国际上认可的拼音
  3. 类名使用 UpperCamelCase 风格,必须遵从驼峰形式,但以下情形例外:

     DO / BO /DTO / VO / AO
    
  4. 方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格,必须遵从 驼峰形式.

  5. 常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字长
  6. 抽象类命名使用 Abstract 或 Base 开头;异常类命名使用 Exception 结尾;测试类命名以它要测试的类的名称开始,以 Test 结尾,不要缩写成abs之类的。
  7. 中括号是数组类型的一部分,数组定义如下:String[] args;虽然有多有定义方式,但是最好只要这一种。
  8. POJO 类中布尔类型的变量,都不要加 is,否则部分框架解析会引起序列化错误。
  9. 包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式,但是类名如果有复数含义,类名可以使用复数形式。
  10. 缩写可以,但是必须是大众所知道,否则就不要缩写。
  11. 尽量完整单词表达语义
  12. 如果模块、接口、类、方法使用了设计模式,在命名时体现出具体模式。
    public class OrderFactory;
    public class LoginProxy;
    public class ResourceObserver;
    
  13. 接口类中的方法和属性不要加任何修饰符号(public 也不要加),保持代码的简洁性,并加上有效的 Javadoc 注释。尽量不要在接口里定义变量,如果一定要定义变量,肯定是 与接口方法相关,并且是整个应用的基础常量。
  14. 枚举类名建议带上 Enum 后缀,枚举成员名称需要全大写,单词间用下划线隔开

results matching ""

    No results matching ""