改善代码审查的7个步骤

最新推荐文章于 2023-03-21 18:03:19 发布

cxu0262

最新推荐文章于 2023-03-21 18:03:19 发布

阅读量230

点赞数

Rob Whitcomb是Surge的高级软件工程师。

在像软件开发这样需要关注细节的领域，同行评审是必不可少的。当最小的错误可能导致整个项目中的严重错误时，另一组（或几组）眼睛将有助于确保一切都发挥最大的潜力。尽管可以执行自动化测试来审核代码，但是没有什么能比人工更好。

[ 什么是GraphQL？ 通过设计更好的API 。 •教程：如何开始使用GraphQL 。 •教程：如何开始使用GraphQL 。 • Microsoft Graph Explorer：一个尚未准备好的好工具。 | 通过InfoWorld的App Dev Report新闻通讯了解编程中最热门的话题。 ]

代码审查已被证明可以大大加快开发过程。但是，代码审查者的职责是什么？运行代码审查时，如何确保建设性反馈？您如何征求意见，以加快和改善项目？这是运行可靠的代码审查的一些提示。

建立目标。 代码审查不仅仅是查找错误和错误。您可能正在考虑添加新功能以及如何实现它们。您可能正在尝试确保代码符合您的组织建立的某些样式标准。无论目标是什么，重要的是您必须在流程的一开始就明确目标，并且团队中的每个人都应理解并朝着目标努力。如果每个团队成员都有不同的目标或观点，将很难达成共识并取得进展。
做你的第一遍。 收到请求后，请尝试尽快获得初始通行证。您现在不必深入。快速浏览一下，让您的团队写下他们的第一印象和想法。
使用票务系统。 大多数软件开发平台都有助于对代码的不同方面进行注释和讨论。提议对代码进行的每次更改都是一张新票。任何团队成员一看到需要进行的更改，便立即为其创建工单。凭单应说明更改的内容，更改的位置以及必要的原因。然后，您团队中的其他人可以查看故障单并添加自己的评论。该系统不仅将帮助您跟踪所有建议的更改，而且该讨论将导致整体代码的进一步改进和完善。
运行测试。 您可以尝试通过逐行查看代码来发现微小的错误，但是通常可以更轻松地运行有问题的代码并查看其工作方式。这样，可以更轻松地找到有关漏洞如何影响您的应用程序的漏洞。它还可以提供有关缺少或可以改进哪些功能的见解。
测试建议的更改。 将代码放入您的测试环境，并查看其如何与建议的更改一起使用。更改有效吗？软件是否有所改进，还是所做的更改引起了更多问题？这些更改是否对项目的整体预算有效？还需要做什么？根据测试创建更多票证以供讨论。
做你的深入通行证。 现在是时候用细齿的梳子筛选代码行，查找错误，样式问题，括号放错位置等了。有些人更喜欢这样做，然后再从第一遍测试建议的更改。他们将等到最后，然后立即测试所有更改。但是测试您的第一遍的更改可以帮助您告知第二遍。另外，进行测试可以节省您的时间和金钱，而不是将所有测试都保存到最后。
提交评估。 您可以修正一些小的更改，例如编码错误和错别字。但是主要的更改应始终与代码的作者首先讨论。问问自己，您提出的更改是否确实是一个问题，或者只是您可能会做不同的事情？因为最后是他们的代码，而不是您的代码。提交对代码的评估后，请与作者联系并找出他们为什么以某种方式做事。然后告诉他们您的方法，看看他们的想法。希望您能够从彼此的角度看待事物，并利用这些见解使代码尽可能地完善。

代码审查是编程中最重要的方面之一。它使您可以更快，更有效地解决问题，并最终交付更高质量的代码和更好的软件产品。您如何在下一个项目中充分利用代码审查？

Rob Whitcomb是Surge的高级软件工程师。 十年来，他一直在使用多种技术来构建企业应用程序。 Surge是Catalyte的公司。

新技术论坛提供了一个以前所未有的深度和广度探索和讨论新兴企业技术的场所。 选择是主观的，是基于我们对InfoWorld读者认为最重要和最感兴趣的技术的选择。 InfoWorld不接受发布的营销担保，并保留编辑所有贡献内容的权利。 将所有查询发送到 newtechforum@infoworld.com 。