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