代码审查报告xxxx公司版本信息文档标识:当前版本:当前状态:草稿发布日期:发布修改历史日期版本作者修改内容评审号变更控制号评审对象审查员项目名称审查日期分类重要性检查项备注命名重要命名规则是否与所采用的规范保持一致
成员变量,方法参数等需要使用首字母小写,其余单词首字母大写的命名方式,禁止使用下划线(_)数字等方式命名不要出现局部变量,成员变量大写字母开头等问题一般是否遵循了最小长度最多信息原则
各种命名尽可能短,表意准确,除2代替‘to’,4代替‘for’外,不建议使用数字在命名中重要has/can/is前缀的函数是否返回布尔型
成员变量,方法参数,局部变量等为布尔型时,如果出现has/can/is开头,则将这些词去掉重要类名是否存在重名问题
自己实现的类尽量不要和别人的类重名,尽管不在同一个包下,特别是子类和父类重名的情况注释重要注释是否较清晰且必要
方法JAVADOC注释中需要说明各参数、返回值及异常说明,参数说明需按照参数名称及用意对应标注重要复杂的分支流程是否已经被注释
一般距离较远的}是否已经被注释
重要函数是否已经有文档注释
(功能、输入、返回及其他可选)文件,类(含接口,枚举等),成员变量,方法前需要有JAVADOC的注释一般特殊用法是否被注释
声明、空白、缩进一般每行是否只声明了一个变量
(特别是那些可能出错的类型)重要变量是否已经在定义的同时初始化
重要类属性是否都执行了初始化
一般代码段落是否被合适地以空行分隔
一般是否合理地使用了空格使程序更清晰
基本代码格式中的空格符不可缺少,这些空格出现在,:,+,-,*,/,=,==,>,=,