当代码很难审查时我们能做点什么?

作者 : 开心源码 本文共2024个字,预计阅读时间需要6分钟 发布时间: 2022-05-13 共289人阅读

代码审查是通过让更多的人关注代码来提高代码质量的一种方法。在解决遗留代码库时,这种做法有助于传播知识、让更多的人熟习代码库并降低破坏代码的风险。

但有时,你可能会遇到代码很难审查的情况。可能是 pull request 很大,或者者变更涉及到代码的许多部分。

也许变化不大,但却很危险!

你会觉得这段代码既脆弱又复杂。变更太大会让你觉得不安全。团队并不清楚这种变更可能带来的反作用。测试套件也不是非常全面。变更似乎有效,但是需要花费过多的时间来验证没有任何回归问题。也许比变更本身花费的时间还要多!

这种情况下就陷入了进退两难的境地:

你是试着找出显著的缺陷并将其合并,而寄希望于没有由于自己知识不完备而漏掉什么?
或者者中止合并,直到你冒着超期的风险,在所有你能想象的场景下对变更进行测试?
当代码很难审查,但又没有时间把所有事情重做一遍时,该怎样办?

即便难以审查,也不能跳过审查!

首先,假如你觉得变更非常困难,以至于没有时间做适当地审查,那么你在审查最后的代码时应该少花点时间。

“合并,而后祈祷没有什么不好的事情发生”是一个非常坏的主意。当你这样做的时候,你靠的是运气。当你运气不好时,你就会失败。总有一天,你会惨败。

想想看:假如代码现在很难审查,那么 6 个月后就会更难维护!你会不记得当时做决定的背景。我们不会动没有上下文的变更,由于我们害怕产生意外的后果!

然而,当你承受着发布的压力时,很难想出不同的方法。

假如你不理解你正在审查的变更所带来的影响,你能做什么?我认为假如你遵循这 5 个技巧,即可以力挽狂澜,把项目推向正确的方向。

审查高难度代码变更的 5 个技巧

1. 关注可读性

我总是会在幻灯片中以下面这句话详情 Software Crafters Montreal meetup:

代码不是你告诉计算机做什么;它是你告诉另一个程序员你想让计算机做什么。

我认为这是可以工作的东西和可以变更的东西之间的区别。

因而,你在审查时首先要注意的是可读性。你理解这个变更的全貌吗?不要试图找到所有可能的 bug。你明白这是怎样回事吗?正在处理的问题是什么?你的团队如何决定通过这个变更来处理问题?

2. 要求证实

你能搞明白这个变更之后这个软件会发生什么变化吗?你理解这些变化背后的用意吗?

手动测试即可以了。通常,在你增加自动化测试之前,遗留代码库就会需要进行大量的变更。短期来看,手动测试可能更快。不要只是在看过屏幕截图或者重现 PR 场景的视频之后就信任代码,你需要做得更多。在合并之前对变更后的代码进行 QA 审查,在变更刚完成的时候,是发现问题的好时机。

把这作为主要关注点,要求查看最终结果的 QA 记录。

3. 要求自动证实

手动测试也可以,但是假如你真的需要节省时间,就应该自动化这些测试。你不可能每次变更时都有时间手动重现所有场景。这项繁重的工作应由计算机来完成。这就是为什么你应该推动团队为代码编写测试。

假如没有测试,就去找他们。

假如变更伴随自动化测试,请确保自己理解它们验证的内容。人们很容易为了编写测试而编写测试,而忽略它们的可读性。好的测试将帮助你了解代码应该做什么。它们可以充任软件的活文档。

假如代码需要大量变更才能进行测试,而你没有时间怎样办?假如你不知道如何才能做得更好,请使用生存模式:尽可能地进行审查,而后借助手动测试。但是,你应该在下一个迭代中优先处理这个问题。

在你希望偿还的所有技术债务中,在代码库上编写自动化测试是最重要的一项!它能节省你的时间,让你更容易在截止日期前完成任务:

自动化测试的执行速度比手动测试快;
自动化测试覆盖到的变更将不太可能引入回归,因而,你花在调试和修复代码上的时间会更少;
测试将迫使你改进代码的设计——关注测试之苦,简化测试过程。

4. 要求进行小变更

对于难以审查的代码,一个常见的情况是差异超过 500 行代码,而形容却简单如“实现取消(Implement cancellations)”。

在这种情况下,要求将变更分解为更小的块。一系列小的、自包含的变更风险较小。通常,一个可行的方法是,首先发布所有不改变代码工作方式的升级,而后发布实现该特性的小变更。

你可以这样说:

我跟不上这里所发生的一切。你能把这个补丁分成更小的步骤吗?

这也将使前面三点变得更容易。这样出错的可能就小了!

5.使用同步代码审查来加速这个过程

假如你承受不起花几天时间审查的话,这里有个秘诀:做笔记,而后和代码开发者同步审查。坐在一起看,或者者通过电话会议分享你的屏幕一起看。

这将帮助你更快地了解逻辑,有助于你理解编码过程中的权衡取舍。通过这个过程,你可以弄清楚哪些变更是关键变更,哪些仅仅是有最好。

使用同步代码审查方法可以节省每次异步注释的往返等待时间。探讨更顺畅,更有成效!最终,你将提出一个具体的计划实现安全地合并。

英文原文地址:https://understandlegacycode.com/blog/what-you-can-do-when-code-is-hard-to-review/

说明
1. 本站所有资源来源于用户上传和网络,如有侵权请邮件联系站长!
2. 分享目的仅供大家学习和交流,您必须在下载后24小时内删除!
3. 不得使用于非法商业用途,不得违反国家法律。否则后果自负!
4. 本站提供的源码、模板、插件等等其他资源,都不包含技术服务请大家谅解!
5. 如有链接无法下载、失效或广告,请联系管理员处理!
6. 本站资源售价只是摆设,本站源码仅提供给会员学习使用!
7. 如遇到加密压缩包,请使用360解压,如遇到无法解压的请联系管理员
开心源码网 » 当代码很难审查时我们能做点什么?

发表回复