成功进行代码审查的6个提示

哈Ha! 我向您介绍文章“成功进行代码审查的6个技巧”的翻译。


代码审查一直是创建干净且可维护的代码的基本实践。


通常,由于当时看来客观上正确的原因,开发人员忽略和低估了代码审查。


让我们今天制定6条提示以进行高质量且有益的代码审查


我-选择正确的时刻


代码审查从选择合适的时机开始。


让我们尝试描述其特征:


  • 被打扰的可能性很小 :您应该避免工作时间,在此期间,根据经验,人们会分散工作流程的注意力。 确实,有些日子通常会比较平静,就在这样的时刻,值得计划一下代码审查。
  • 头脑清晰 :您在审核开始之前和过程中都不会感到压力,例如,担心即将与客户会面。 另外,要检查其代码的程序员必须处于平静状态,以便您之间没有紧张关系,以免破坏审查代码的过程。
  • 开发人员保证代码已准备好进行验证 :浪费时间检查尚未准备好的内容是没有意义的。 准备就绪是指代码正在运行,没有任何不好的实践,已记录在案,至少已被单元测试覆盖。 根据经验,如果开发人员自己分配时间进行代码审查,那么他更有可能给出自己不感到羞耻的验证代码。

II-设定界限


提前了解即将到来的代码审查规模是值得的。


考虑一项或多项功能? 在有时间的情况下,考虑太多是否有意义?

通常,我想集中精力进行有限的更改,以便更好地了解它们的含义,而不是在代码段之间跳转得太频繁。


要正确设置任务的边界,您可以:


  • 执行可见大小的分配任务 。 为此,将大型任务分为小任务和原子任务,例如,在Jira或什至在经典Scrum板上。
  • 正确设置代码验证的优先级 :如果等待验证的任务过多,您将看不到所有内容。 选择优先级。

III-营造合适的氛围


在开始代码审查之前,请在您周围营造一个良好的氛围。


为此需要什么?


  • 最少的外来声音数量 :如果周围的噪音尽可能小,您将提高工作效率。 毕竟,它越小,浓度就越好。
  • 没有“中断”区域 :类似于在第一部分中描述的区域,值得避免的是它们可以使自己脱离过程的时刻。 在单独的房间中这样做更容易。
  • 积极批评区 :批评别人的作品是一个复杂的过程。 但是,当周围有很多人时,执行此操作甚至更加困难。 在封闭的房间里,您可以自由说话,而不必担心被窃听。

IV-聊天,再次聊天


代码验证不是单向过程。


成功的代码审查很大程度上取决于与同事进行尊重和有效沟通的能力。 毕竟,不仅检查员宣布什么是对的,什么不是对的。


代码审查是关于一切的对话:范围,意图,更正甚至是分歧。


在此过程中,请尝试遵循以下建议:


  • 不仅要听,而且要听 :意见和观点经常不同,每种分歧都必须引起对该问题的建设性讨论。 每个观点都需要关注。
  • 中立语调 :检查代码不是考试或宗教裁判所,让您感觉像是在判断代码,而不是编写代码的人。
  • 疑惑-指定 :如果您不确定具体的实施细节,请提出疑问 。 乍一看并不明显的某些意图在将来常常会引起误解。

V-记住最终目标


代码审查应该导致最终结果 :它可能是建设性的批评,也可能是对代码 进行改进或与gitflow中选择的相应开发分支集成集成的技巧。


这是审阅者的责任。


但是,您如何判断代码是否可以集成?

以下是一些有助于做出决定的标准:


  • 编写的代码解决了语句中描述的问题。
  • 该代码已正确包含在单元测试中
  • 正确解决的合并冲突。
  • 没有明显的代码气味或不良行为的迹象。

VI-使用特殊工具


有一些工具可以轻松进行代码验证。 您可以毫不犹豫地使用它们,以简化代码检查和集成的过程。


三个品牌在代码验证软件市场上处于领先地位: Smartbear(与协作者)Perforce(与Helix Swarm)Atlassian(与Crucible)


此类工具通常提供用于组织代码审查的广泛工具,以及使团队不断改进的指标。


这不仅仅是用于比较代码的工具,而且它们与几乎所有可用的版本控制系统集成在一起。


试试看!


轮到您分享了!


如果您在开发人员的日常生活中遇到其他提示或特定示例,请在评论中分享。

Source: https://habr.com/ru/post/zh-CN480718/


All Articles