如何做代码评审?

引言

        代码评审是指在开发过程中对代码的质量与效率进行检查。代码评审是所有开发团队都应该有的一个行为,在开发过程中定期的检查代码,有助于提前防止架构异变,提前发现隐藏的BUG,完善设计细节。

        代码评审也是个绝佳的学习机会,团队中的个人可以借助这个机会快速的提升自己的研发能力,进而拉高整个研发团队的能力。

关注点

  • 正确性。代码的变更部分是否与现有架构建立的模式一直?是否存在与现有模式相抵触的地方?是否需要重构代码,或者采用现成的架构模式?设计模式的选取是否合理?
  • 一致性。检查命名。命名是否有意义?是否有晦涩难懂的命名?代码与预期的有多大出入?
  • 可测试性。变更部分是否有清晰的单元测试?每一次构建都通过测试了吗?测试是否存在不充分或者不一致的情况?
  • 可修改性、可维护性。是否有硬编码的情况?代码是否可以变得更灵活?是否引入了新的未通过评审的依赖?注释是否逻辑清晰?日志打印是否合理?
  • 稳定性。异常处理是否前后一致?是否存在错误没有考虑到的情况?是否有重试机制?有没有采用防御性编程的思想?代码是否存在大量占用内存的可能性?算法是否高效?是否在适当的时候使用了线程安全的数据结构?

标准步骤

  1. 确定参与者,并且提前给出需要评审的代码,告知到所有参与者,提前熟悉代码逻辑。
  2. 通过远程会议、邮件、面谈的方式组会,持续时间不宜过长,一般控制在30分钟以内,可以跟团队人员做好约定定期开展。。
  3. 快速阅读变更集,对变更范围形成整体印象。
  4. 各参会人员发表意见,重点检查设计细节、代码风格、缺陷,并做好相关记录。
  5. 自由讨论时间,通常架构级别的问题需要评审结束后进一步单独组会讨论。
  6. 回顾评审结果,确定修改内容与截止日期。

建议

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

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

是在下了

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值