代码审计报告.doc

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