做代码审查CodeReview有哪些关注点?

代码审查(Code Review)是为了保证代码质量,控制代码的错误和提升开发团队的技能而进行的一种活动。

功能方面

  1. 修改范围:我在CR时第一关注点是修改范围与需求是否一致,如果修改范围扩大,会造成变更不可控,是极为危险的。

  2. 功能实现:代码是否满足功能需求或修复了相应的Bug,代码实现的逻辑是否正确?这个会通过在方案评审时就做好准备。设计方案评审需要3人以上有CR权限同学参加,最后CR人至少是这三人中的两个。

  3. 自我检查机制:比如与第三方交互前后要打日志,是否需要配套相关的数据一致性措施。当然,这些在设计阶段一般会定好。

  4. 错误和异常处理:检查是否有错误处理和异常处理机制,以防代码在遇到错误时崩溃。

可靠性方面

  1. 性能优化: 检查代码是否有可能影响性能的地方,如是否有不必要的循环,是否使用了正确的数据结构、算法时间复杂度和空间复杂度是否达标。

  2. 安全性: 检查是否有可能导致安全问题的地方,如SQL注入、跨站脚本(XSS)问题等。对于敏感数据,要确保其在使用、传输和存储过程中的安全性。

  3. 可测试性:检查代码是否容易进行单元测试,是否有足够的测试覆盖率。这个一般会通过CI/CD来保证,一般会有一个整体性的要求,比如要达到85%的行级单测覆盖率、80%的分支覆盖率、100%的单测成功率。

  4. 可维护性和可扩展性: 针对代码的结构和设计进行审查,代码是否易懂,接口设计是否良好,逻辑是否清晰,是否遵循遵循开放/封闭等设计原则是否利于后续的扩展和维护。

ce36296d873d30f8a1afc67357ff8b6c.jpeg

审查不仅对查找和修复代码问题有好处,对于提升团队的编程技能,减少代码的潜在问题,把控项目的整体质量也有着重要作用。要注意的是,代码审查时应持有敬业和尊重他人的态度,代码风格这些仁者见仁的尽量不要在CR阶段来讨论,到了这个阶段,尽量尊重开发者的习惯。避免过于苛刻的评语,审查的目的是为了帮助他人提高,而不是吹毛求疵。

  • 4
    点赞
  • 10
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值