Code Review学习:目标和内容

Posted on Sat 07 January 2012 in it • Tagged with Code Review, 研发管理

Code Review的目的和内容

检查设计是否合理

Code Review需要承担一部分“结对设计”和“设计把关”的职责 内容包括:

  1. 设计是否合理:如实现方法,数据结构,设计模式,扩展性考虑等
  2. 否存在大量重复代码和其他组件是否有重复的代码
  3. 结构设计是否合理

互为Backup

Code Review 中,Review 的开发人员了解代码的设计和实现,传递了技术,开发人员互为Backup,方便后期的维护,也减少了项目风险。

分享知识、设计、技术

Code Review是一个学习和享受的过程,一个开发人员的能力有限,而Code Review正是这样的一种机制,让好的知识、设计在团队中分享,实现整体团队的成长和整体的效益最大化。

提高代码可读性

代码的要求不止是能运行功能正确的代码,而是有了更高的要求,即Code for maintenance。 可维护的代码,需要清晰,可读性强,这里可读性代码检查不是指代码格式(代码格式可以通过工具检查出),而是指代码语义 ...


Continue reading

[他山之石]赖勇浩的强制Code Review实践

Posted on Thu 05 January 2012 in it • Tagged with Code Review, 研发管理

Code Review的好处

  1. 代码风格可控,代码质量有一定提升;
  2. 新员工入职后能够得到更多人的指导,成长非常快;
  3. 小 bug 频出的情况比之前的项目少了至少一个数量级。

Code Review的流程

  1. 使用 reviewboard 作为工具,通过 SVN hooks 强制每一次签入都是经过 review 的;
  2. 至少要有 2 个团队成员 ship it,才能够签入;
  3. ship it 的成员中,至少有一个是资深的团队成员。

Code Review的详细步骤

  1. 团队成员在提交代码之前,需要先使用 post-review 工具在 reviewboard 上创建一个 review request。一个配置良好的 reviewboard 能够自动发送邮件给所有成员;
  2. 收到邮件通知后大家抽空去 review 代码,而 review 结果也会通过邮件知会给大家,所以发起 ...

Continue reading