代码评审怎么做?

Code Review 是软件开发过程中非常重要的一个环节,不过相对于单元测试,大家可能接触更少,同时,想要做好 Code Review 往往也更困难。在这篇文章里,我会先普及 Code Review 的常识,然后讲一些自己在实践中积累的经验。PS,这也是一篇会保持更新的文章 : )

什么是 Code Review?

Code Review 翻译成中文是代码评审,具体的定义可以看 wiki。这篇 wiki 介绍说 Code Review 在帮助团队找到代码缺陷这件事上作用巨大:“代码审查一般可以找到及移除约65%的错误,最高可以到85%”。实际上, Code Review 的好处远不止这一条,它至少能在以下三个方面帮到我们:

  1. 传播知识。相信很多人第一次提交 Code Review 都有类似的经历:短短几百行代码,却被提了密密麻麻几十条 comments,更新了十多次代码,才最终被 accept 。其实当代码被 accept,提交代码的工程师通过这次 review 就学习到了代码规范和很多好的实践。同时,通过 review 更资深工程师的代码,年轻的工程师也更直观地学习架构和编码;另外,工程师之间也可以通过 review 代码来共享项目知识,看代码实现在绝大多数时候是了解项目的最好方式。

  2. 增进代码质量。这点也很容易理解,有经验的工程师可以在架构设计、代码细节等各个方面帮助到初学者。不同工程师也会有知识盲点,互相 review 进步也很快。另外,被 review 的代码质量更高还有一个很多人注意不到的心理因素:在状态不佳的时候,工程师难免会匆忙写些“潦草”的代码,但是当你知道自己的代码会被review 的工程师提交 comment 打回来,自然会更仔细些 : -)

  3. 找出潜在的 bug。这是大部分团队进行 Code Review 的目的。就像上面提到的,Code Review 在这方面效果不错。其实我认为大部分代码 bug 应该由单元测试,功能测试,性能测试和回归测试来保障。不过由于静态分析不理解业务,另外有些 bug 在测试中并不容易复现,这两种情况下,经验丰富的

  • 2
    点赞
  • 14
    收藏
    觉得还不错? 一键收藏
  • 2
    评论
代码review评审表记录是一种用于记录程序代码评审过程中出现的问题和建议的工具。它可以帮助团队成员在进行代码评审时进行有条理的记录,并提供参考便于后续的修改和改进。 评审表记录的内容通常包括以下几个方面: 1. 代码规范:记录代码是否符合团队所规定的编码规范,例如命名规范、注释规范、代码缩进等,以确保代码的可读性和可维护性。 2. 功能实现:记录代码是否按照需求文档中所描述的功能进行实现,是否有功能上的遗漏或错误。 3. 错误处理:记录代码中是否考虑到了可能出现的边界条件和异常情况,并了相应的错误处理。 4. 性能优化:记录代码是否存在性能瓶颈或潜在的性能问题,并提供相应的优化建议。 5. 可测试性:记录代码是否易于单元测试和集成测试,并提供测试覆盖率和测试用例的建议。 6. 可扩展性:记录代码的可扩展性,即代码是否易于进行功能扩展和维护。 评审表记录的格式通常是表格形式,其中包括问题描述、问题所在的代码位置以及建议的修改或改进方式。评审表记录还可以包括评审人员的姓名和评审日期等信息。 通过记录评审表,可以将代码评审过程中发现的问题和建议进行整理和归档,便于开发人员在后续的修改和改进过程中参考。同时,也可以作为开发团队的经验总结,为日后的项目开发提供借鉴和指导。总之,评审表记录是促进代码质量提升和团队合作的重要工具。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值