Google 鼓励的 13 条代码审查标准,建议收藏( 二 )


Google 鼓励的 13 条代码审查标准,建议收藏文章插图
我们绝对不可以跳过测试 。 如果时间有限 , 某些目标有无法实现的风险 , 那么解决方案不是跳过测试 , 而是限定可交付成果的范围 。
Google 鼓励的 13 条代码审查标准,建议收藏文章插图
不要为了代码审查打断手头的工作如果你正在专心致志地工作 , 那么请不要打断自己 , 因为你需要花费很长时间才能重新投入工作 。 换句话说 , 打断专心工作的开发人员所付出的代价远远超过了让开发人员等待代码审查 。 你可以在休息(午餐或咖啡等)过后 , 进行代码审查 。
Google 鼓励的 13 条代码审查标准,建议收藏文章插图
大多数时候 , 整个代码审查以及代码的合并无法在一天内完成 。 重要的是迅速给作者一些反馈 。 例如 , 虽然可能无法完成完整的审查 , 但你可以快速指出一些有待探讨的地方 。 这可以极大地降低代码审查期间的挫败感 。
Google 鼓励的 13 条代码审查标准,建议收藏文章插图
审查所有代码 , 不要做任何假设你需要审查提交上来的每一行代码 。 不要对人工编写的类和方法做任何假设 , 而且应该确保你理解代码在做什么 。
Google 鼓励的 13 条代码审查标准,建议收藏文章插图
确保你理解正在审核的代码 。 如果不理解 , 则请作者澄清或提供代码演示和解释 。 如果你不具备审核部分代码的资格 , 则请其他有资格的开发人员代为审查 。
Google 鼓励的 13 条代码审查标准,建议收藏文章插图
审查代码时需要保持大局观从更广阔的视野来看待代码变更会更有帮助 。 例如 , 某个文件被修改 , 并添加了4行新代码 。 请不要只看这4行代码 , 你应该考虑审查整个文件 , 并检查新添加的内容 。 它们是否会降低现有代码的质量?它们是否会导致现有功能成为重构的候选对象?
如果不在函数/方法或类的背景下审查添加的代码 , 则随着时间的流逝 , 你将会得到一个面临无法维护、纠缠不清、不易于测试等问题的类 , 而且这个类很难扩展或重构 。
请记住 , 即便是微不足道的改进 , 随着时间的推移 , 也可能导致产品出现缺陷 , 同样 , 即便是轻微的代码降级或技术负债也可能在日积月累下导致产品难以维护和扩展 。
Google 鼓励的 13 条代码审查标准,建议收藏文章插图
在代码审查期间认同和鼓励出色的工作如果看到出色的代码变更 , 请别忘了大力表扬和鼓励作者 。 代码审查的目的不仅仅是发现错误 , 而且还应该鼓励和指导开发人员出色的工作 。
Google 鼓励的 13 条代码审查标准,建议收藏文章插图
在代码审查期间应保持谨慎、尊重、友善和思路清晰在代码审查期间 , 你应该保持友善、思路清晰、有礼貌和尊重别人 , 这一点至关重要 , 同时也要给予作者清晰的反馈和积极的帮助 。 在审查代码时 , 你需要做到对事不对人 , 即对代码做出评论 , 而非开发人员 。
Google 鼓励的 13 条代码审查标准,建议收藏文章插图
详细解释代码审查的意见 , 并注意尺度每当代码审查意见提出替代方案或指出某些问题时 , 重要的是你需要解释其中的原因 , 并根据个人的知识和经验提供示例 , 以帮助开发人员理解为何你的建议能够提升代码质量 。
在建议修改或变更代码时 , 你需要在如何指导作者修改代码方面找到适当的平衡 。 例如 , 我更喜欢指导、解释、提示或建议 , 而不是整个解决方案 。
感谢你的阅读 , 希望你喜欢这篇文章 。 如果有任何意见或建议 , 请在下方留言 。
原文:
本文为 CSDN 翻译 , 转载请注明来源出处 。
Google 鼓励的 13 条代码审查标准,建议收藏文章插图
Google 鼓励的 13 条代码审查标准,建议收藏文章插图

Google 鼓励的 13 条代码审查标准,建议收藏文章插图
【Google 鼓励的 13 条代码审查标准,建议收藏】点分享
Google 鼓励的 13 条代码审查标准,建议收藏文章插图
Google 鼓励的 13 条代码审查标准,建议收藏文章插图