为什么要关注code review
记得自己前两年工作的时候,老大一直让我们项目上线之前code review,我也是仅仅听听就算了,没有真正的核实代码,所以这件事一直搁在心里,存在脑子里,偶尔记起来了就想着去学一下,一直拖到现在,决定这两天花时间好好整理一下,也算把之前欠的技术慢慢弥补起来。
什么是code review
code review是指在软件开发过程中,对源代码的系统性检查。目的是查找系统缺陷,保证软件总体质量和提高开发者自身水平。
为什么要进行code review
- 有利于提高代码的质量
- 可以尽可能早的发现潜在的Bug和代码缺陷,提高整体项目代码运行速率
- 促进团队内部知识共享和交流,有利于团队的团结和团队整体水平的提高
code review的原则
- 明确的Coding规则,通常包括大括号的位置,变量名和函数名,行的长度,缩进,格式和注释等。
- 尽量保证代码是否简单易懂,是否有多余或是重复的代码。
- 尽可能的对代码进行模块化
code review的好处
review 代码其实也是一个再学习思考的过程,在review的过程中,我们应该坚持开发者能说清楚代码解决的什么问题,怎么解决的,每行代码是干什么用的。在review的过程中就会重新审视代码,并把之前没有搞懂的考虑清楚。整个过程不仅有利于提高代码质量,而且有利于提高个人的技能。而且在review代码的时候,团队成员彼此之间的交流,也是一个相互学习的过程。
code review需要注意的问题
- 团队review代码需要持之以恒,在团队执行过程中正确对待,对于做的好的团队或者个人,予以表扬;对于做的有所欠缺的团队或者个人,应当提出批评并要求和督促其及时改进。
- 团队leader在code review的时候,要明确review代码是对事不对人,要理解review是为了发现项目代码的缺陷,而非人自身的问题。不要将review代码的活动变性为针对被审查人的人身攻击,背离了review代码的初衷。
- 团队每次的code review的过程和review的结果进行总结,并以文档的形式在团队公开和保存起来,方便后期给新进的人提供一些建议,少走一些弯路。
code review的最终目的
总而言之,code review的好处是很明显的,不仅对公司、团队文化的建设有作用,而且对项目整体代码质量的把握和团队成员技术水平的提高都有很大的作用。无形当中提高了工作效率和产品质量。