python代码走查清单
1. 代码的注释是否和代码逻辑一致
解释:当代码的注释与代码逻辑不一致时,会对维护和定位问题产生干扰。所以如果走查的代码中包含注释,或者代码本身归属于某个注释的解释范围,均需要核对修改后代码与注释是否一致。
2. 变量的命名是否代表了其作用
解释:变量的命名值得更多的时间投入。如果几个代码段中变量名称一样,但是含义又有些差别,就很容易在后续开发使用中产生故障,并且给代码阅读带来更多麻烦。
3. 关注循环边界值是否符合预期
解释:循环结构中最常见错误,就是边界设置问题。需要检查语法上是否包括代码写下的边界、也需要检查业务逻辑上是否和编码的逻辑边界是否吻合。
4. 关注条件判断逻辑是否充分必要
解释:一个代码段中包含多个相互关联的条件判断、或者包含一个多条件判断语句,需要保持警惕仔细推敲:多条判断语句前后语句判断顺序是否递进充分,多条件但语句中的每一个条件是否必要合在一起是否充分。
5. 输入参数是否进行异常判断
解释:单从软件产品质量上看,防御式编程是具有明显优势的。而且对开发人员的能力要求上也不会过高,避免不同人开发质量差异大的问题。
6. 是否所有执行语句均捕获了异常
解释:对异常流程的处理是产品软件代码质量的主要判断依据之一。为避免主观判断错误和知识漏洞导致的异常未捕获问题,所有涉及IO的操作以及与运行主体之外的交互均需要捕获异常。
7. 全局变量的全局唯一与并发冲突限制
解释:是否保证了全局变量的全局唯一性,避免使用同名的局部变量。如果在并发处理中涉及修改全局属性,那么必须检查冲突解决机制;即读写数据同步问题的解决方案。