代码走查

代码审核者需要关注什么?

  • 设计:代码是否经过精心设计并适合您的系统?

  • 功能:代码是否符合作者的预期意图?代码对用户的行为方式好吗?

  • 复杂性:可以简化代码吗?将来,当其他开发人员遇到该代码时,他们是否能够轻松理解和使用该代码?

  • 测试:代码中是否包含正确且设计良好的自动化测试?

  • 命名:开发人员是否为变量,类,方法等选择了清晰的名称?

  • 评论注释是否清晰有用?

  • 样式:代码是否遵循我们的 样式指南

  • 文档:开发人员是否也更新了相关文档?

原则

通常,即使CL并不完美,一旦处于肯定可以改善正在使用的系统的整体代码运行状况的状态下,审阅者就应该批准它。

参考资料

  1. 原版:https://google.github.io/eng-practices/review/

  2. 翻译版:https://juejin.im/post/5d80c27cf265da03e61b45c7

Last updated