是否需要有代码规范
代码规范是一件我们应该做,也必须做得事情!程序就是应该这种风格,程序就是应该这样写。假如团队中的某一个人要求都使用他定的规范,那么在程序开发过程中,很多没有适应这种规范的人就会花大量的时间再代码规范上,严重影响了程序的开发进程。因此,继承前辈们的成果总是会比团队中的某一个人定规范要好。
代码互审报告
0.变量和常量的命名是否与约定保持一致?是
- 是否存在容易混淆的相似的变量和属性名?是
- 变量和属性是否书写正确?是
- 非局部变量是否能用局部变量替换?否
- 变量和属性是否被正确的初始化?不适用
- 所有的for循环的控制变量是否都在循环顶部被声明?是
- 是否有应该命名为常量的文字常量?否
- 变量和属性是否可以用常量替换?否
- 属性是否可以用本地变量?否
- 所有的属性是否都有正确的访问限制符?是
- 方法名的描述方法是否与命名约定一致?是
- 每个方法的参数值在使用之前是否都作了检查?否
- 对于每一个方法,它是否都返回了正确的值?是
- 每一个类是否都有正确的构造函数和析构函数?是
- 在子类中是否有应该放到父类中的通用成员?否
- 类的继承层次是否能被简化?否
- 对于每一个数组引用,下标值是否在定义的范围内?是
- 对于对象和数组引用,是否确定其值应为非空?是
- 是否存在不同类型数据之间的混合计算?是
- 在计算中是否存在上溢或下溢的可能?否
- 关于数值计算的顺序和优先级的假设是否正确?是
- 是否用了括号来避免模糊不清?是
- 对每一个布尔测试,正确条件是否被检查?否
- 比较操作符是否正确?是
- 每个布尔表达式是否都正确?是
- 比较操作是否存在不引人注意的副作用?是
- 对于每一个循环:是否选用了最佳的循环结构?不适用
- 所有的循环是否都能结束?是
- 如果一个循环有多个出口,是否每个出口都有必要并且得到正确处?否
- switch声明是否都有default条件?是
- 是否所有的case-switch-break对应关系都已更正并加上批注?否
- 循环和分支的嵌套是否过深?是否正确?否,是
- 是否有if嵌套可以转换程switch嵌套?否
- 空控制叙述是否都正确,并加上括号及批注?否
- 所有的异常是否都得到了正确的处理?否
- 每一个方法是否都结束?是
- 文件在被使用之前是否都被打开?是
- 输入对象的属性是否与使用的文件一致?是
- 文件在被使用之后是否都被关闭?否
- 文本中是否有拼写和语法上的错误?否
- 所有的I/O异常处理的是否合理?否
- 方法调用的参数的数量,顺序,类型和值是否与该方法声明一致?是
- 如果对象或数组被传递,它们是否改变?是否被调用方法正确改变?是,是
- 每一个方法,类和文件是否都有适当的头注释?否
- 每一个属性,变量和常量的声明是否都有注释?否
- 每个类和方法的潜在行为是否都有用简易的语言进行解释?否
- 方法和类的头注释是否和它们的功能保持一致?是
- 注释和代码是否保持一致?是
- 注释对于理解代码是否有帮助?是
- 代码中的注释是否充分?否
- 代码中的注释是否过多?否