7个让代码审查更好的步骤

举报
thundye 发表于 2018/10/15 17:38:38 2018/10/15
【摘要】 代码审查可以使软件更好,开发人员更好,团队更好。按照以下步骤操作即可。在软件开发等需要注重细节的领域,同行评审至关重要。当最轻微的错误在整个项目中造成严重错误时,另一组眼睛(或几个)将有助于确保一切都充分发挥其潜力。虽然可以执行自动化测试来审核代码,但没有什么能比人更好。已经证明代码审查可以显著加快开发过程。但是代码审查者的责任是什么?运行代码审查时,如何确保建设性反馈? 如何征求能够加快和...

代码审查可以使软件更好,开发人员更好,团队更好。按照以下步骤操作即可。


在软件开发等需要注重细节的领域,同行评审至关重要。当最轻微的错误在整个项目中造成严重错误时,另一组眼睛(或几个)将有助于确保一切都充分发挥其潜力。虽然可以执行自动化测试来审核代码,但没有什么能比人更好。

640.jpg

已经证明代码审查可以显著加快开发过程。但是代码审查者的责任是什么?运行代码审查时,如何确保建设性反馈? 如何征求能够加快和改进项目的投入? 以下是运行可靠代码审核的一些提示。


1.建立目标。代码审查不仅仅是发现错误和错误。可能正在考虑添加新功能以及如何实现它们。可能正在尝试确保代码符合组织建立的某些样式标准。无论目标是什么,重要的是在流程的最初阶段清楚地表明这些目标,并且团队中的每个人都理解并努力实现目标。如果每个团队成员有不同的目标或观点,就很难达成共识并取得进展。


2.第一次接触。收到请求后,尽快尝试尽快接触。先不着急深入探讨。只需快速浏览一下,让团队写下他们的第一印象和想法。


3. 使用工单系统。大多数软件开发平台都有助于对代码的不同方面进行评论和讨论。每个建议的代码更改都是新工单。只要任何团队成员看到需要进行的更改,他们就会为其创建一个工单。故障单应描述变化的内容,变化的位置以及变更的原因。然后,团队中的其他人可以查看故障单并添加他们自己的评论。该系统不仅可以帮助跟踪所有建议的更改,而且讨论将导致整体代码的进一步改进和完善。


4. 运行测试。可以通过查看一行一行代码来尝试发现微小的错误,但通常更容易运行有问题的代码并查看它是如何工作的。这样做,在它们如何影响应用程序的环境中更容易找到错误。它还可以提供有关哪些功能缺失或可以改进的信息。


5. 测试提议的更改。将代码放入测试环境中,看看它如何与建议的更改一起运行。这些改变是否有效?软件是否有所改进,或者更改引起了更多问题?这些更改是否适用于项目的总体预算?还有什么需要做的?根据测试创建更多讨论门票。


6. 深入了解。现在是时候用精细筛选代码行,找到错误,样式问题,错误的括号等等。有些人喜欢在测试第一遍的建议更改之前这样做。他们会等到最后,然后立即测试所有的变化。但是,测试第一次通过的更改可以帮助通知第二次通过。此外,随时测试可以节省时间和金钱,而不是将所有测试保存到最后。


7. 提交评估。随着时间的推移,可以修复诸如编码错误和拼写错误之类的微小变化。但是应该首先与代码的作者讨论重大变化。问问自己,你提出的改变真的是一个问题,还是你会做出不同的改变?因为最终,这是他们的代码,而不是你的代码。一旦您提交了对代码的评估,请与作者交谈并找出他们为什么以某种方式做事。然后告诉他们你的方法,看看他们的想法。希望能够从彼此的角度看待事物,并利用这些见解使代码成为最佳代码。


代码审查是编程最重要的方面之一。它能够更快速有效地解决问题,并最终提供更高质量的代码和更好的软件产品。将如何在下一个项目中充分利用代码审查?


【版权声明】本文为华为云社区用户原创内容,转载时必须标注文章的来源(华为云社区)、文章链接、文章作者等基本信息, 否则作者和本社区有权追究责任。如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容,举报邮箱: cloudbbs@huaweicloud.com
  • 点赞
  • 收藏
  • 关注作者

评论(0

0/1000
抱歉,系统识别当前为高风险访问,暂不支持该操作

全部回复

上滑加载中

设置昵称

在此一键设置昵称,即可参与社区互动!

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。