@zhangever
2017-01-05T23:50:30.000000Z
字数 539
阅读 1028
代码评审要点
开发原则
编程规范
- 代码已经经过了格式化以及包引用优化
- 方法体不能太大。一个方法体不超过
90
行,一行不超过100
列
- 对于scala方法,无参getter方法定义的时候不要带括号
- 代码是否简单易读且添加了必要的注释?
- 尽量模块化,不允许存在多余或者重复的代码
- 识别可以被现有库函数或者基础库函数取代的代码
- 不允许出现注释掉的代码
- 多余的日志或者调试代码要删除
函数式风格
- 优先使用不可变量,避免使用可变量,包括var以及mutable collections
- 如果一定要使用可变量, 那么必须向开发负责人申请代码review
- 避免复杂的
if ... else
,使用模式匹配去重写它
- 使用新的EmptyChecking,统一对逻辑Empty的检查。
- 服务代码中避免 null 的使用,对基本类型,使用Option[T] 替代,对集合类型,使用 List.Empty 或者类似集合替代
安全
- 非阻断流程的第三方服务接口调用,是否使用了异步调用方式或者设置了超时?
文档
- 所有非getter/setter方法是否都已做了注释,包括输入输出返回?
- 注释是否很好描述了代码的意图?
- 单行注释建议通过
//
放到代码行右边
- 对非常规行为和边界情况处理是否有描述
- 是否有未完成的代码?如果是的话,是不是应该移除,或者用合适的标记进行标记比如
TODO
?