Code Review 规范

Posted 2020-09-01 因上努力，果上随缘

CodeReview规范

CodeReivew 标准

1. 通用原则

   • 提交 PR 的代码必须保证自测通过
   • 只 review 代码规范、业务逻辑，不 review 架构设计（那是写代码前应该做的事情）
   • 干掉重复代码，合理复用代码
   • 合理命名变量、函数、API 的名字（具体参考各语言规范）
   • 删除无用代码（包括以后可能会用的代码，用时再加入）
   • 重要函数入口、复杂的业务逻辑要有注释（注释标准见各语言规范）

2. Python 代码规范

   • https://guoruibiao.gitbooks.io/effective-python/content/

3. Java 代码规范

   • 1. Java 命名规范 参见[ google java style ]
        1. 1为统一所有同事的代码格式，需要安装IDE的plugin 来强制格式化文件（具体，参见 https://github.com/google/google-java-format）

     2. Java Code 实现规范

        1. 谨慎使用接口，如无必要，不必抽象

           接口的使用有一些场景:

           • 抽象公共的行为 (要求有至少2个实现)
           • 使用JDK 原生的Proxy
           • 定义框架扩展点

           不满足以上场景，不必抽象

        2. 尽量使用公共组件库，强烈不推荐自己实现Utility（如guava/apache commons）

        3. 尽量使用异常，避免错误码

        4. 参数验证尽量前置

        5. 时间统一返回成long (毫秒级)

        6. 对float/double 精度问题保持警惕

        7. 尽量使用JDK lambda