引领先锋|Google鼓励的13条代码审查标准( 二 )


8.专注时 , 不要打扰自己进行代码审查如果您正处于重点工作中 , 请不要打扰自己 , 因为这可能需要很长时间才能恢复正常 。 换句话说 , 打断专注的开发人员所付出的代价比让开发人员等待代码审查要高得多 。 在计划的休息时间(例如午餐 , 咖啡等)之后进行代码检查 。
引领先锋|Google鼓励的13条代码审查标准期望并非总是在同一天完成并合并整个代码审查过程 。 重要的是迅速给作者一些反馈 。 例如 , 您可能无法进行完整的检查 , 但是您可以快速指出一些可以研究的内容 。 这将极大地减少代码审查期间的挫败感 。
9.复习一切 , 不要做任何假设查看分配给您检查的每一行代码 。 不要对人工编写的类和方法做任何假设 , 并且应该确保您了解代码在做什么 。
引领先锋|Google鼓励的13条代码审查标准确保了解您正在检查的代码 。 如果没有 , 请进行澄清或要求代码演练/解释 。 如果您有部分代码不具备审阅的资格 , 请确保还有其他合格的开发人员可以审阅代码的那些部分 。
10.回顾代码时要顾全大局从更广泛的背景来看变化通常是有帮助的 。 例如 , 更改了文件 , 并添加了四行代码 。 不要只查看四行代码;相反 , 请考虑查看整个文件并检查新添加的内容 。 它们会降低现有代码的质量 , 还是会使现有功能成为重构的候选对象?
如果不在函数/方法或类的上下文中检查此类简单的添加项 , 则随着时间的流逝 , 您将继承一个类 , 该类是不可维护的 , 超级复杂的 , 难以测试的 , 无法完成的所有工作 , 并且难以扩展或重构 。
请记住 , 随着时间的推移 , 很少的改进加起来就可以产生具有最少数量缺陷的优质产品 , 同样 , 随着时间的流逝 , 轻微的代码降级或技术负担也会加重并导致产品难以维护和扩展 。
11.认可并鼓励代码评审期间的良好工作如果您在变更列表中看到了一些不错的东西 , 请别忘了喊出作者的出色作品并鼓励他们 。 这是我个人以前从未做过的事情 。 代码审查的目的不仅应该是发现错误 , 还应该鼓励和指导开发人员所做的出色工作 。
12.在代码审查中要谨慎 , 尊重 , 友善和清晰至关重要的是 , 在代码审阅期间 , 您要善良 , 清晰 , 礼貌和尊重 , 同时也要对作者非常清楚和乐于助人 。 查看代码时 , 请确保对代码而不是开发人员做出评论 。
13.解释您的代码审查注释 , 并牢记范围每当代码审阅意见提出替代方法或进行标记时 , 至关重要的是要解释原因并根据您的知识和经验提供示例 , 以帮助开发人员了解您的建议将如何帮助提高代码质量 。
当建议修复或更改时 , 请在如何指导作者修复代码方面找到适当的平衡 。 例如 , 我很欣赏指导 , 解释 , 一些提示或建议 , 而不是整个解决方案 。
感谢您的阅读 , 希望您喜欢这篇文章 。 如果您有任何意见或建议 , 请在评论区留言回复 。
【引领先锋|Google鼓励的13条代码审查标准】#DevOps# #持续集成# #持续交付#


推荐阅读