介绍我们 Code Review

1、 什么是 Code Review ?
2、 表现模式
3、 为什么要 CR ,CR 能带来什么

思路就是,讲道理,举例子,道理阐述CR的优势,事实证明。

什么是 Code Review ?

你Google一下Code Reivew这个关键词,你就会发现Code Review的好处基本上是不存在争议的,有很多很多的文章和博文都在说Code Review的重要性,怎么做会更好,而且很多公司在面试过程中会加入“Code Review”的问题。wiki词条代码审查

Code Review的好处,主要是让你的代码可以更好的组织起来,有更易读,有更高的维护性,同时可以达到知识共享,找到bug只是其中的副产品。这个东西已经不新鲜了,你上网可以找到很多文章,我就不多说了。就像你写程序要判断错误一样,Code Review也是最基本的常识性的东西。

(这部分,我copy 了一点网上的文章,http://coolshell.cn/articles/11432.html ,然后你来补充,我的想法是,要从你的角度,来解释什么是CR 。)

如果说,我刚开始对于CR 的理解,就是,我写代码,导师看,找错误。改进。。大白话。。

表现模式

下面是一张实际任务的CR 图片。在你提交代码,发起 pull merge 之后,你的 Code Reviwer 会对你的 代码进行 review ,相对应的地方会进行标注和说明。

review

为什么要 CR ,CR 能带来什么

这里实际举一个学员开发过程中实际的例子,从一个新人的角度。展示CR 能够带来什么。

在完成第一个项目之后,写的代码基本实现功能,满心欢喜提交审核。

但是这些代码是充满问题的。

1、格式上基本都不规范,良好的代码规范,(巴拉巴拉。。你补充下。。)

举例中可以看出来,这位同学的代码存在很多不规范的地方。这些都是不好的代码习惯。
不利于进行代码阅读和维护。

代码规范1

代码规范3

代码规范2

2、 新人的代码,一般都有很多代码功能上的问题。

新人写好一个代码,功能可以实现,但是在代码细节上,会存在很多不必要的内容。或者对于函数构造命名 不好的地方。

下面例子,里面,学员的代码,虽然功能实现了,但是仍然存在很多的问题。这里导师会对其中的问题一一提出来。

代码内容1

代码内容2

代码内容3

3、 有些时候,学员觉得的完成,实现功能可能完全错误。

下面这个例子,学员测试代码之后,提交内容,但是提交的代码和要求完全不同, 学员自己觉得,返回了数据就可以了,其实并没有按照项目要求,代码逻辑整体错误了。

在自己学习中,也会出现一些,你觉得懂了,其实错了的情况。CR 可以帮你纠正这样的错误。

代码逻辑错误

4、一些细微的错误,学员可能不细心,提示过了仍然没有修改。这里导师会反复提醒,直到修改正确。

良好细心的写代码,是一个很好的习惯,这样能够有效避免由于 输入错误,字段描述错误等带来的问题。

粗心错误

粗心错误1

总结

不论是对于初学的新手,还是有一定基础的学员,CR 都能让你的代码规范、代码内容获得提升和成长。
一个好的代码风格,代码逻辑,我感觉是程序员的一笔财富。

(这里我没啥经验啊,就是,回文,重复一遍刚开始CR 的好处的东西。上面不是有例子么。结合例子来写,刚好有理有据,比较有说服力。)

发表评论

电子邮件地址不会被公开。 必填项已用*标注