在 2025 收官前,看清 Data + AI 的真实走向,点击查看 BUILD 大会精华版 了解详情
写点什么

代码审查的实践要素

  • 2013-07-08
  • 本文字数:1481 字

    阅读完需:约 5 分钟

虽然代码审查是一个被广泛采纳的实践,但是由于存在很多的实践方式,所以开发团队经常搞不清楚它的最佳实践是什么样的,Lorinda Brandon 尝试从多个方面来分析了正确的代码审查时间应该重点考虑的几个因素。

人员结构

在你的团队中有多少同事拥有足够的专业技能来担当合格的代码审查者?作者曾经和多个开发团队沟通过,这些团队都声称本身只有一个资深的开发人员,如果让他来负责所有的代码审查工作,那么团队的核心开发就无法开展了。作者也遇到过类似的情况。在一个小规模团队里,资深的同事总是忙不过来,因为核心的工作都在等着他做。

地理位置

你的团队成员是如何分布的?他们是否是分散在世界各地还是坐在同一个敞亮的办公室里? 代码审查需要精力的专注和反馈,如果开发人员能够面对面的沟通,那么审查工作会便于实施。而物理隔离的远程团队很难达到代码审查的满意结果。

所在领域

你所在的IT 领域需要遵守怎样的规则和约束呢?如果你在一个受到严格监管的行业,那么你必须遵循有关审计和报告的规则,这意味着你必须想办法跟踪代码审查的频率和质量。如果所在的领域把安全性作为重点,那么可能在代码审查过程中要引入安全审计。

复杂性

你的代码复杂性如何?在代码审查时,需要多个不同专业技能的审查者吗?例如,游戏开发可能会引入非常复杂的业务逻辑来处理文字交互和场景跟踪,同时还需要特定的动画处理和内存管理技术。在审查如此复杂的代码时,应该引入多个审查者从不同角度来检阅代码的质量。

而且在许多情况下,不同的项目有不同的需求——存在多个团队构建应用,需要不同的配置文件。这里有一些技巧可以帮助你改进代码审查过程的工具并解决一些可能会面临的问题:

1. 促进沟通

任何审查过程,不论是代码还是文档还是绩效,最好是面对面进行。在你使用工具做完代码审查之后,与相应的开发人员约个时间做口头的反馈。如果你们不在同一地区,可以利用视频或者电话来进行沟通,但是这种沟通是必要的,你可以以此作为协作和指导的一种手段。

2. 利用专业技能

如果被审查的代码与其他代码领域存在关联,或者对安全、性能、可扩展性等方面存在一定的影响,你可能无法只安排一个人来完成审查工作。你需要多个人来查看代码以确保所有可能的后果都被考虑在内。在这种情况下,最好找到一个工具来协助多个人完成审查工作。该工具的作用包括指定哪个人审查哪个角度并把相应的代码展现出来,而且还可以保存审查人员的注解。

3. 公开审查意见

审查工具的优点之一是多人可以集中地审查相同的代码。把所有人叫到一个屋子里做团队审查非常不利于大家考虑各个不同的方面。但是工具可以帮助你让大家分别查看代码并把所有的意见集中起来:

  • 避免意见重复,如果别人已经发表了类似的看法,那么后面的人就不用记录了。
  • 团队学习,通过查看别人的意见能够学习其他人的思维角度和专业领域。
  • 监督审查过程。

提到代码审查的工具,坚果云团队建议“使用好的工具进行轻量级的代码审查”:

“工欲善其事,必先利其器”。我们使用的是 bitbucket 提供的代码托管服务。每个团队成员独立开发功能,然后利用 Pull Request 的形式将代码提交给审查者。复审者可以很方便在网页上阅读代码,添加评论等,然后原作者会自动收到邮件提醒,对审阅的意见进行讨论。即使团队成员分布在天南海北,利用 bitbucket 提供的工具也能很好的进行代码审查。

Eric Landes 在一篇名为《敏捷技巧:什么时候以什么方式来进行代码评审》的文章中,提供了一个时间安排的例子:

  1. 概览本次代码评审的故事 (10 分钟)
  2. 讨论团队指标 (10 分钟)
  3. 强调评审的特别关注点 (5 分钟)
  4. 深入地评审代码 (55 分钟)
  5. 代码覆盖率
  6. 架构
  7. 深入的分析报告
  8. 总结并记录行动事项 (10 分钟)
2013-07-08 08:213405
用户头像

发布了 501 篇内容, 共 286.3 次阅读, 收获喜欢 64 次。

关注

评论

发布
暂无评论
发现更多内容

极客时间架构师训练营 - week2 - 作业2

jjn0703

极客大学架构师训练营

Flink on Zeppelin (1)入门篇

Geek_8o1tcx

大数据 flink 流计算 Zeppelin

设计模式原则

张瑞浩

架构师训练营-每周学习总结2

水边

极客大学架构师训练营

架构师训练营-命题作业2

水边

极客大学架构师训练营

依赖倒置原则以及week2 作业

不在调上

极客大学架构师训练营

思维模型 - 组合式创新

石云升

思维模型 组合式创新 拆解组合

一文讲透SpringMVC

知春秋

spring springmvc Servlet

架构师训练营第二周作业

小树林

学习笔记-第二周

薛定谔的🐴

极客大学架构师训练营

这 10 行比较字符串相等的代码给我整懵逼了,不信你也来看看

程序猿石头

性能优化 信息安全

学习总结-编程本质与架构设计原则

飞雪

架构师训练营——Week2作业

Shawn

ARTS-week-3

youngitachi

ARTS 打卡计划 arts

架构师训练营第2周作业

风吹

架构师训练营作业(二)

Glowry

极客大学架构师训练营

设计模式

张瑞浩

【省吾身】创新及其发生条件

luojiahu

创新 日常思考

「编程模型」C++资源引用

顿晓

c++ 智能指针 shared_ptr make_shared 资源引用

week2 学习总结

不在调上

作业

飞雪

如何更好的使用Gson

Jackey

Java Gson

架构师训练营-学习笔记-第二周

心在飞

极客大学架构师训练营

极客时间架构师训练营 - week2 - 作业1

jjn0703

极客大学架构师训练营

互金总结系列(2)-- 前后端分离

互金从业者X

「架构师训练营」学习笔记:第 2 周

Amy

极客大学架构师训练营 作业

每周 ARTS 第 33 期

落英坠露

ARTS 打卡计划

认识依赖倒置原则(DIP)

极客大学架构师训练营 第二周作业

以“血联网”缓解“血荒” “硬科技”赋能生物安全

CECBC

区块链技术 智慧血站 物联网化

ARTS-WEEK3

一周思进

ARTS 打卡计划

ARTS-WEEK2

Allen

代码审查的实践要素_语言 & 开发_崔康_InfoQ精选文章