Skip to content

Latest commit

 

History

History
23 lines (19 loc) · 1.7 KB

codeReview.md

File metadata and controls

23 lines (19 loc) · 1.7 KB

关于code review

  1. 首先明确code review意义:
  • 发现错误:人都会不可避免的出现一些纰漏,而这些纰漏在另一个人眼中也许显而易见。
  • 健壮性检查:代码是否健壮,是否有潜在安全、性能风险。代码是否可以回滚
  • 质量保证:在一般情况下,新提交的代码一定需要写测试,测试不只可以保证你的提交符合预期,还可以在后人改你的代码时有一层保障。同时,MR 阶段也有机器人自动检查当前分支的测试覆盖率是否低于主分支,当低于主分支时会标红警示,但不会禁止 merge。
  • 统一风格:对于整个团队来说,代码风格的统一很重要。风格统一除了人 Review,我们也引入了静态代码检查,不符合团队风格的代码,是无法通过 CI 的,这个交给插件去做,code review应该关注在插件不能检测出来的方面
  • 完善注释:包括 commit message、代码中复杂实现是否有解释性的注释、紧急 hack 是否明确标注等。
  • 互相学习
  1. 经常反思
  • 什么写法可能导致性能低下?
  • 哪个接口要慎用?
  • 哪些设计方式需要规避?
  • 什么习惯容易引发内存泄漏?
  • 并且对遇到的问题进行归纳总结
  1. 一些代码常常有一些待完成的事项或者以后需要修正的点,那么在代码里面标注好TODO,写下待办事项的名字和具体的工作,就是十分常见的行为了。

  2. 推荐软件 google开源的:https://www.gerritcodereview.com/

  3. 具体关注点:

  • 模块拆分,减少大的模块,优化多重嵌套
  • 方案设计是否恰当、代码是否啰嗦、变量命名是否恰当