代码审计报告3.doc

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