代码规范

Posted 2021-02-27 dadaimayidingyaoxiao

代码规范

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

• 变量命名:
  使用 lowerCamelCase 风格，必须遵从驼峰形式

• 每行最多字符数:
  单行字符数限制不超过 120 个

• 函数最大行数:
  单个方法的总行数不超过 80 行

• 函数名:
  使用 lowerCamelCase 风格，必须遵从驼峰形式

• 类名:
  类名使用 UpperCamelCase 风格
  抽象类命名使用 Abstract 或 Base 开头；
  异常类命名使用 Exception 结尾；
  测试类命名以它要测试的类的名称开始，以 Test 结尾。

• 常量:
  常量命名全部大写，单词间用下划线隔开
  不允许任何魔法值（即未经预先定义的常量）直接出现在代码中
  在 long 或者 Long 赋值时，数值后使用大写的 L，不能是小写的 l，小写容易跟数字 1 混淆，造成误解
  不要使用一个常量类维护所有常量
  如果变量值仅在一个固定范围内变化用 enum 类型来定义。

• 空行规则:
  不同逻辑、不同语义、不同业务的代码之间插入一个空行分隔开来以提升可读性。

• 注释规则：
  类、类属性、类方法的注释必须使用 Javadoc 规范，使用/内容/格式，不得使用// xxx 方式
  方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部多行注释使用/ */注释，注意与代码对齐。
  操作符前后空格:
  左小括号和字符之间不出现空格； 同样，右小括号和字符之间也不出现空格；而左大 括号前需要空格
  任何二目、 三目运算符的左右两边都需要加一个空格。

• 其他规则:
  获取当前毫秒数 System.currentTimeMillis(); 而不是 new Date().getTime();
  任何数据结构的构造或初始化，都应指定大小，避免数据结构无限增长吃光内存。
  获取当前毫秒数 System.currentTimeMillis();