Skip to content

Latest commit

 

History

History
38 lines (36 loc) · 2.35 KB

codestyle.md

File metadata and controls

38 lines (36 loc) · 2.35 KB
Raw

  • 缩进

    • 缩进采用4个空格，禁止使用tab字符。

  • 变量命名

    • 变量命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。
    • 变量命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。
    • 方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase风格，必须遵从驼峰形式。
    • 杜绝完全不规范的缩写，避免望文不知义。

  • 类命名

    • 类名使用UpperCamelCase风格，必须遵从驼峰形式，但以下情形例外：（领域模型的相关命名）DO / BO / DTO / VO等。
    • 抽象类命名使用Abstract或Base开头
    • 异常类命名使用Exception结尾
    • 测试类命名以它要测试的类的名称开始，以Test结尾

  • 枚举

    • 枚举类名建议带上Enum后缀，枚举成员名称需要全大写，单词间用下划线隔开
    • 如果变量值仅在一个范围内变化用Enum类。如果还带有名称之外的延伸属性，必须使用枚举类

  • 每行最多字符数

    • 单行字符数限制不超过 120个，超出需要换行，换行时遵循如下原则：
      • 第二行相对第一行缩进 4个空格，从第三行开始，不再继续缩进
      • 运算符与下文一起换行
      • 方法调用的点符号与下文一起换行
      • 在多个参数超长，逗号后进行换行
      • 在括号前不要换行

  • 函数最大行数

    • 200行

  • 常量

    • 常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。
    • long或者Long初始赋值时，必须使用大写的L，不能是小写的l，小写容易跟数字1混淆，造成误解。

  • 空行规则

    • 方法体内的执行语句组、变量的定义语句组、不同的业务逻辑之间或者不同的语义之间插入一个空行
    • 相同业务逻辑和语义之间不需要插入空行

  • 注释规则

    • 方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部多行注释使用/ */注释，注意与代码对齐。
    • 所有的枚举类型字段必须要有注释，说明每个数据项的用途。
    • 与其“半吊子”英文来注释，不如用中文注释把问题说清楚。专有名词与关键字保持英文原文即可。

  • 操作符前后空格

    • 除单目运算符外任何运算符左右必须加一个空格。