Code Review过程中需要注意的问题

 

这段时间在和其他人一起作Code Review，在此作一个总结：

• 空杯心态
  Code Review是一个知识分享的过程，包括实际的经验和教训。因此不论如何，需要保持一个谦虚平和的心态。代码的作者对需要解决的问题比任何人的理解都来得清楚，因此在下结论之前多问几个为什么，弄清楚作者这样处理的原因。
• 以身作则
  在任何一个项目组中，能力总是存在高低之分、强弱之别，但是这并不意味着一个新手犯的错误不会出现在一个老手的代码中，因此经验丰富的老手需要首先检查自己是否犯了类似的错误。当发现错误时，需要侧重于分析问题，总结经验，进而培养新人。
• Guideline是一个Guide
  Guideline是所有项目参与者需要遵循的一个规则，但是这并不意味着Guideline考虑到了所有的情况，总归会有例外存在，这时就需要使用另外的方法，而不应拘泥于Guideline的规定。在Code Review的过程中需要考虑到这一点，并把遇到的情况记录下来，充实到Guideline中。但是在一个项目中一个人对于类似情况的处理须要保持一致。
• 正确性->可读性->简洁性->运行效率
  不论何时，代码的正确性是第一位的，其次是可读性。一个人所负责的代码风格需要保持一致，以利于其他组员阅读和理解。代码首先是写给人看的，然后才是机器。
• 总结文档化
  在Code Review阶段性完成后，需要将发现的问题，对于问题的分析，相应的对策以及可能存在的例外情况进行总结，并编辑成为文档，分发给项目参与者，以利于项目参与者能力提高。