美文网首页Java
当代码很难审查时我们能做点什么?

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

作者: 马小莫QAQ | 来源:发表于2020-11-13 22:10 被阅读0次

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

但有时,你可能会遇到代码很难审查的情况。可能是 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/

相关文章

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

    代码审查是通过让更多的人关注代码来提高代码质量的一种方法。在处理遗留代码库时,这种做法有助于传播知识、让更多的人熟...

  • 如何做代码审查

    作者: 耳朵里有风 一、代码审查概述 代码审查 3W What: 什么是代码审查 对计算机源代码系统化审查,常用软...

  • 代码审查(Code Review)清单

    (转)代码审查(Code Review)清单在我们关于高效代码审查的博文中,我们建议使用一个检查清单。在代码审查中...

  • 代码审查(Code Review)的本质

    什么是代码审查? 代码审查是一个过程,即代码只有经过非作者本人评审后才能进入代码仓库。 代码审查的目的 但是大家为...

  • 当遭遇不幸时,我们能做些什么

    生活总喜欢和我们开玩笑,有时候甚至能被生活打趴下,即便如此,我们也总还得做些什么。 当疫情来袭时,有人可能因过世而...

  • 代码审查查什么?

    不应该做的 格式:在什么地方放置空格和断行符?使用制表符还是空格?大括号如何放置? 风格:变量、参数是否声明为fi...

  • 我们能做点什么

    第2辑 我们能做点什么 黄石市龚家巷小学小风筝班 2017-3-8 卷...

  • iOS 代码评审

    1、CodeReview Code Review 中文应该译作 “代码审查” 或是 “代码评审”,这是一个流程,当...

  • 如何使代码审查更高效

    要点 代码审查者在审查代码时有非常多的东西需要关注。一个团队需要明确对于自己的项目哪些点是重要的,并不断在审查中就...

  • 代码审查应该关注什么

    本文是“代码审查关注什么”系列文章的第一篇(共六篇)。 我们一起来讨论下代码审查。如果你花几秒钟时间搜索一下代码审...

网友评论

    本文标题:当代码很难审查时我们能做点什么?

    本文链接:https://www.haomeiwen.com/subject/ntobbktx.html