代码质量的保证——代码审查

Posted 程序猿武道馆

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了代码质量的保证——代码审查相关的知识,希望对你有一定的参考价值。

代码审查是保证代码质量的重要手段,代码审查不会检查代码的功能和逻辑,更多的是站在更高的角度,审视代码的结构以及可能存在的隐患,提出相应的改进方案。


那么,问题来了,到底什么人对代码进行审查呢?


程序员自己审视自己的代码是一个重要的手段,但是,个人的思路总是有一定局限性的,总会沿着自己习惯的思维方向进行思考,不太容易发现自己代码的问题。一般代码审查需要由团队中有一定威信的人组织进行,这个人可以是团队中的技术能人,也可以是懂技术的领导。总之,这个人对代码的评价应当能够让人信服,否则,发现再多的问题,没人赞赏并乐意修改,都是多余的。


代码审查的依据首先是公司的编码规范,而编码规范只是审查的最基本部分,编码规范应当包括每行代码的最大长度,变量的命名规则,函数的命名规则,变量类型的使用规则等等。代码中如果出现不符合代码规范的内容,需要及时修改。这些直接影响了代码的可读性和可维护性。


其次,要对代码的防御性进行必要的审查。比如,动态分配的内存是否回收,指针是否进行必要的null判断,函数入口参数合法性是否进行了必要的检验等等。所有这些,目的都是提高代码的健壮性,防止不必要的疏忽造成的代码缺陷。


接下来,要对代码的结构进行必要的审查。比如看看代码中是否有过长的条件判断,是否有过长的函数,是否有重复代码,这些都是代码中的坏味道,应当采取一定的手段对代码进行重构。


最后,代码审查过程要尽可能避免批评,以建议的方式对代码提出改进要求,主要目的是让参与代码审查的人在期间学习到改善代码质量的手段。如果审查过程中发现被审查代码的优点,也可以拿出来在团队内部进行分享,作为学习素材分享给大家。


代码审查对于代码的质量改善有很好的作用,可以每周进行一次,但是实际中很多公司可能忽视了代码审查的作用,或者将代码审查作为劣质代码的批斗会,这些都是不可取的。应当营造好的氛围,让团队成员赞同代码审查,并积极参与其中,将代码审查中学到的东西,应用于平时的工作当中,从而形成代码质量改善的良性循环。



苹果用户可长按或扫描下方二维码进行赞赏




以上是关于代码质量的保证——代码审查的主要内容,如果未能解决你的问题,请参考以下文章

程序员必看:如何充分利用代码审查提升你的代码质量?

代码质量和审查状况年度报告!-2017(中文版)

如何利用代码审查提升你的代码质量?

实验四 代码评审

实验四 代码评审

Codacy:一个新的容易使用的代码质量和审查自动化解决方案