【技术研究】 CodeReview初识

一、codeview是什么？

    codeview是代码评审，不是代码分析。代码评审也称代码复查，是指通过阅读代码来检查源代码与编码标准的符合性以及代码质量的活动。

 

二、为什么要使用codeview？（好处）

1、提高代码质量

2、在项目的早期发现缺陷，将损失降至最低

3、评审的过程也是重新梳理思路的过程，双方都加深了对系统的理解

4、促进团队沟通、促进知识共享、共同提高

5、交叉评审——代码走查：团队成员互相检查代码

 

三、什么时候进行codereview？

可以选择在下班前半小时，对当天改动的模块进行评审。开发进行到某一阶段时，对共性问题进行总结，对

好的做法进行提炼和推广。

 

四、如何进行codereview？

   参与者：包括项目组全体成员，其它组的开发组长也应尽量参加。

   结对方式：可以是任意两个组员，或开发组长分别与每个组员结对进行。

   代码作者讲解如何以及为何这样实现、评审者提出问题和建议。

   注意：每次解决的问题要记录到SVN注释或JIRA

      每次评审不要贪多，当一次评审超过400行代码时，能发现缺陷数显著降低——事倍功半

   会审：以项目为单位，召开专门的代码评审会议。

   比如，我们在集体开发过程中，写完自己的代码后，检查没有错误后，提交到SVN上。代码虽然没有错误，但是可能有其他问题：代码冗余，逻辑错误，没有写日志、异常处理，或不符合项目的格式要求等，我们需要再次检查代码处理这些问题。代码量多了之后，检查工作会变得很复杂。

   所以，我们研究代码审查工具来解决这些问题。过程如下：

   本地修改代码，提交SVN，设置审核者，编写修改注释；

   审核者会收到审核请求邮件，审核者在Phabricator中会看到Audit中有待处理审核，审核者进行审核；

   如果审核者认为代码需要修改的话，codewriter就不应该把代码提交到SVN，而是应该修改之后再次执行arc diff命令，直到所有的审核者都认为代码OK了之后才应该使用arccommit，提交到SVN上。所有的diff都会在Phabricator被记录，而且可以使用arc获取回来，后续再研究。

   因为审查者在每次组员提交代码后进行评审，所以每次评审的任务量变少了，更容易发现问题。

 其他介绍，请见百度：https://baike.baidu.com/item/%E4%BB%A3%E7%A0%81%E8%AF%84%E5%AE%A1/8960487?fr=aladdin