代码审计报告总结3.docVIP

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