Code Review 五问五答

Code Review 是什么？

Code Review即代码审查，程序猿相互审核对方的代码。

Code Review能获得什么好处？

• 提高代码可维护性
  • 你写的代码不再只有编译器看了，你得写出审核人能看得下去的代码，
    并且还得考虑这段代码还有没有改进或者重构的可能
• 提高代码质量
  • 不再有明显的逻辑错误，单元测试用例是否考虑边界值等情况，从而减少BUG的产生
• 团队知识共享
  • 新的技术或者新的思路能够快速的在团队内传递
• 提高项目预估准确性
  • 通过代码审核，让产品经理或者Scrum Master能更好的了解任务，更准确的估算工时
• 业务或功能不再只依赖个人
  • 没有人喜欢修改别人的代码，尤其是生产环境中的核心业务代码。代码审查可以让至少另一个人对这段代码如数家珍
• 指导新工程师
  • 代码审查有助于促进新成员更快的加入团队，快速掌握业务和技术知识

提交Code Review之前要做什么？

• 准备或者提交相关需求文档以备审查者询问
• 编写符合规范的代码和合适的注释
• 考虑代码是否有重构的可能
• 单元测试全部通过，测试覆盖率达标

如何Code Review？

• 了解需求：这个提交是为了解决什么问题，是需求单、BUG修复、还是代码重构，
  如果不明确，需要及时和代码作者沟通和讨论
• 检查代码业务逻辑是否符合需求
• 代码是否符合相关代码规范
• 确认是否有更好的方式方法重构代码
• 检查单元测试用例是否考虑全面
• 如果代码没有问题，也写上类似GOOD JOB之类的评论

Code Review之后可以做什么？

• 对于代码审查人表示感谢
• 如果代码审查没有通过，不要往心里去，审查的是代码，不是你
• 尝试对每一个评论做出回复
• 等待合并分支，等待持续集成告诉你全部通过

参考链接

• (https://github.com/thoughtbot/guides/tree/master/code-review)
• (https://smartbear.com/learn/code-review/best-practices-for-peer-code-review/)
• (https://smartbear.com/learn/code-review/guide-to-code-review-process/)