整洁代码

变量命名

规范

• 采用驼峰式命名
• 使用读得出来的名称
• 类名和对象名应该是名词或名词短语
• 方法名应该是动词或动词短语
• 常量命名全部大写
• 抽象类命名采用Abstract或Base开头
• 异常类命名使用Exception结尾
• 测试类命名以它要测试的类的名词开始，以Test结尾
• 名词长短与其作用域大小相对应

注意事项

• 不使用中文名称
• 不使用小写字母l和大写字母O作为变量名
• 不使用某些专门名词
• 不以下划线或美元符号开始
• 不以下划线或美元符号结束

---

函数

编写原则

• 要短小
• 只做一件事
• 遵循向下规则
  每个函数后面都跟着位于下一抽象层级的函数，这样在查看函数列表时，能够遵循抽象层级自顶向下读代码

函数参数

• 函数参数尽量不要超过三个。
  超过三个参数的，应该将其中一些参数封装为类。
• 函数参数中不要传入布尔值。
  布尔值为TRUE，函数执行一种逻辑；布尔值为FALSE，函数执行另一种逻辑。这样违背了一个函数只做一件事的原则。
• 函数参数是0个或1个为最佳。
  函数参数是2个时，可能在调用时，会搞错两个参数的顺序，尽量将二元函数转变为一元函数。
• 函数参数中不要出现输出参数。

代码规范

• 使用异常替代返回错误码
• try-catch代码块，try部分的逻辑应该单独抽离出现形成一个函数。
  不要将错误处理与正常流程混淆。

---

注释

对注释的使用理解

• 别给糟糕的代码写注释，重新把代码写整洁再写注释
• 注释不能随着代码变更而随之变动，注释的位置要恰当
• 代码可以维护，注释没法维护
• 误导性、有错误的注释的代码，比没有注释的代码， 更糟糕

注意事项

• TODO注释要定期查看并删除
  TODO注释的代码块，是程序员认为应该做，但由于某些原因目前还没做的工作。该代码块被搁置，需要并且也只能由写出该注释的人尽快处理。
• 直接把代码注释掉是一种讨厌的做法，不能这么做
  其他人不敢删除注释掉的代码，以为代码依然放在那里，一定有其原因，而且这段代码很重要，不能删除。
  不需要的代码，直接删除，删除掉的代码可以用git等版本控制工具进行恢复。
  

  ---

格式

代码格式原则

• 垂直方向上，要有必要的空白行，可以区分不同的代码块
• 水平方向上，要有必要的缩进

规范

• 实体变量应该在类的顶部声明
• 有相同命名模式的函数，即使没有互相调用，也应该放在一起
  

  ---

错误处理

• 不要返回null值
• 别传递null值
  

  ---