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

最新文章

  1. 安装fcitx [Crunch bang] [debian]
  2. TCP连接——爱的传声筒
  3. KMA & ex_KMP---Revolving Digits
  4. HDU 5795:A Simple Nim(博弈)
  5. sql server 查询分析器消息栏里去掉“(5 行受影响)”
  6. hiho_1041 国庆出游
  7. 用xcode6.3编译早期工程时出现Undefined symbols for architecture x86_64错误的解决办法(转)
  8. BZOJ1089: [SCOI2003]严格n元树
  9. Python 在Windows下安装matplotlib
  10. 基于visual Studio2013解决C语言竞赛题之1063分橘子
  11. MySQL (三)-- 字段属性、索引、关系、范式、逆规范化
  12. 2018上C语言程序设计(高级)作业- 第1次作业
  13. pip install
  14. PHP IDE选择标准
  15. CSS学习笔记之样式规划
  16. 在Eclipse中指定JDK
  17. chrome 浏览器调用 ocx 插件
  18. Azure 镜像市场虚拟机映像制作指南
  19. logging日志管理--将日志打印在屏幕上
  20. ERROR: cannot launch node of type [robot_pose_publisher/robot_pose_publisher]: robot_pose_publisher

热门文章

  1. 浅谈APP的分享功能,有时候社交裂变形式比内容更“重要”
  2. UVA - 10972 RevolC FaeLoN
  3. restful的认识和用法
  4. Java RandomAccessFile类
  5. Java并发编程实战 读书笔记(一)
  6. BZOJ3295动态逆序对
  7. SpringMVC中 Controller的 @ResponseBody注解分析
  8. 字符串(NSString)及常见字符串处理函数
  9. 纯CSS3美化radio和checkbox
  10. MachineLearningInAction