代码走查(Code Review) 是一个开发人员与架构师集中讨论代码的过程。通过代码走查可以提高代码的
质量,同时减少Bug出现的几率。但是在小公司中并没有代码走查的过程在这里总结和记录一些代码走
查的要求,时刻提醒自己注重代码质量,每天下班前自己走查一下自己的代码。代码走查一些注意事项
如下:
- 代码的注释与代码是否一致?注释是否是多余的?
- 是否存在超过3层嵌套的循环与/或判断?
- 变量的命名是否代表了其作用?
- 所有的循环边界是否正确?
- 所有的判断条件边界是否正确?
- 输入参数的异常是否处理了?
- 程序中所有的异常是否处理了?
- 是否存在重复的代码?
- 是否存在超过25行的方法?
- 是否存在超过7个方法的类?
- 方法的参数是否超过3个?
- 是否有多种原因导致修改某个类?
- 当发生某个功能变化时,是否需要修改多个类?
- 代码中的常量是否合适?
- 一个方法是否访问了其他类的多个属性?
- 某几项数据是否总是同时出现,而又不是一个类的属性?
- switch语句是否可以用类来替代?
- 是否有一类的职责很少?
-
是否有一个类的某些属性或者方法没有被其他类所使用?
-
在类的方法中是否存在如下的调用形式:a.b().c()?
-
是否某个类的方法总是调用另外一个类的同名方法?
-
是否某个类总是访问另外一个类的属性与方法?
-
是否两个类完成了类似的工作,使用了不同的方法名,却没有拥有同一个父类?
-
是否某个类仅有字段和简单的赋值方法与取值方法构成?
-
是否某个子类仅使用了父类的部分属性或方法?
这25条疑问就是代码规范的修炼手册,这25条疑问是别人总结出来的,记录在此用于提醒自己,
原文出处:https://blog.csdn.net/zzh920625/article/details/51475191