以前公司整理的code review需要注意的要点,个人觉得还是正确的,所以把它展示出来,大家如果有更好的内容,欢迎评论。
code review需要检查的内容
(1)函数参数的检查:所有传入的参数要检查是否合法,不能假设合法。(检查不能使用assert)(2)函数的返回值检查:函数调用后,要检查返回值,有相应的错误分支处理逻辑。
(3)所有变量使用前要初始化(或清空)
(4)动态分配的资源在分配后,要有是释放的代码。有open的地方,也要有close。
(5)检查程序的逻辑是否有bug
(6)检查程序的实现是否有性能问题,代码是否足够优化。
(7)代码引用的问题:同一份代码不得多次复制使用,要求封装成一个函数调用。同一个常量如果被引用2次以上,使用常量变量引用替代。
(8)变量名、类名的命名是否规范:Java使用通用的Java code style,Objective C使用通用的OC命名规范
(9)所有的函数定义要有注释。程序中的逻辑给予必要的注释。
(10)所有被注释掉的代码,提交前要删除。避免其他人恢复被注释的代码,引入bug
(11)文件头规范(copyright author)
(12)使用空格代替tab,代码的缩进要规范
(13)不得提交与源代码无关的,编译后输出内容(如.class文件)