代码审查是一种出色的软件工具,您绝对应该使用它来提高代码质量。 但是像其他任何工具一样,有时可能会误用它。 这就是为什么我提出了一些最佳做法来指导您查看同行代码的原因。
- 代码审查不是测试 :代码审查是开发人员对开发人员的业务,它不涉及任何测试。 代码审查应检查是否以最干净的方式满足任务要求。
- 您无需告诉代码审查内容 :与不告诉测试人员要测试什么内容的方式相同,您永远不应告诉同行要审查什么内容。 同行评审的魔力来自于同行自己对当前任务设计和实施的看法。 两种思想总是比一种思想更好。
- 您应该始终检查所有更改 :错误可能隐藏在任何地方,您应该认真搜索。 要了解整体情况,您需要进行所有更改。
- 需求至上 :需求是最重要的推动力。 毕竟,这就是客户所要支付的。 如果当前更改不理想,则需要重新打开该问题。 如果碰巧发现需要重构的其他代码部分,则应创建新问题,而不是重新打开当前问题。 “单一责任原则”适用于任务以及编码。
- 一对多活动 :如果您不能确定自己掌握了代码更改的意图,请其他人进行进一步检查是比较安全的。
- 学习方式 :代码审查是一种很棒的学习技术,特别是在大型项目中。 理想情况下,您应该熟悉项目的各个方面,但是如果项目太大,则至少可以专门研究多个模块。
快乐的代码审查!
翻译自: https://www.javacodegeeks.com/2014/02/code-review-best-practices.html