1、代码审查报告xxxx 公司版本信息文档标识： 当前版本：草稿当前状态：发布 发布日期：修改历史日期 版本 作者 修改内容 评审号 变更控制号评审对象审查员项目名称审查日期分类 重要性 检查项 备注 命名 重要命名规则是否与所采用的规范保持一致？成员变量，方法参数等需要使用首字母小写，其余单词首字母大写的命名方式，禁止使用下划线(_)数字等方式命名不要出现局部变量，成员变量大写字母开头等问题一般 是否遵循了最小长度最多信息原则？各种命名尽可能短，表意准确，除 2 代替to ，4 代替 for外，不建议使用数字在命名中重要has/can/is 前缀的函数是否返回布尔型？ 成员变量，方法参数，局部变
2、量等为布尔型时，如果出现 has/can/is 开头，则将这些词去掉重要 类名是否存在重名问题？自己实现的类尽量不要和别人的类重名，尽管不在同一个包下，特别是子类和父类重名的情况注释 重要 注释是否较清晰且必要？ 方法 JAVADOC 注释中需要说明各参数、返回值及异常说明，参数说明需按照参数名称及用意对应标注重要 复杂的分支流程是否已经被注释？ 一般 距离较远的是否已经被注释？ 重要函数是否已经有文档注释？（功能、输入、返回及其他可选）文件，类（含接口，枚举等），成员变量，方法前需要有 JAVADOC 的注释一般 特殊用法是否被注释？ 声明、空白、缩进一般每行是否只声明了一个变量？（特别是那
3、些可能出错的类型） 重要 变量是否已经在定义的同时初始化？ 重要 类属性是否都执行了初始化？ 一般 代码段落是否被合适地以空行分隔？ 一般 是否合理地使用了空格使程序更清晰？基本代码格式中的空格符不可缺少，这些空格出现在?,:,+,-,*,/,=,=,=,=等前后加上一个空格。 一般 逗号之后必须接一个空格。 一般关键字、保留字和左括号之间必须有一个空格。 SQL注释 重要对较为复杂的 SQL 语句加上注释，说明算法、功能。注释风格：注释单独成行、放在语句前面。重要 对重要的计算应说明其功能。 SQL 中尽量少涉及业务逻辑一般可采用单行/多行注释。（- 或 /* */方式）。 SQL优化性能建
4、议1 书写 SQL 语句优化细则 重要1) 尽量避免相同语句由于书写格式的不同，而导致多次语法分析。 重要 2) 多表连接时，使用表的别名来引用 建议最多 5 个连接列。重要3) 不要在任何代码中使用SELECT *。 重要4) where 条件中尽量减少使用常量比较，改用参数变量。 重要5) 尽量少用嵌套查询。如必须，请用not exist 代替 not in 子句。 重要 6) 用多表连接代替 EXISTS 子句。 重要 7) 使用 UNION ALL 提高性能 。 重要8) in、or 子句常会使用工作表，使索引失效；如果不产生大量重复值，可以考虑把子句拆开；拆开的子句中应该包含索引。2
5、 排序注意事项 重要1) 大量的排序操作影响系统性能，所以尽量减少 orderby 和 group by 排序操作。如必须使用排序操作，请遵循如下规则：重要 a. 排序尽量建立在有索引的列上。 重要b. 如结果集不需唯一，使用union all 代替 union。 3 选用索引注意事项 重要1) 对于复合索引，SQL 语句必须使用主索引列。 重要 2) 索引中，尽量避免使用 NULL。 重要3) 对于索引的比较，尽量避免使用NOT=（!=）。 重要4) 查询列和排序列与索引列次序保持一致。 4 其他经验性规则 重要1) 任何对列的操作都将导致表扫描，它包括数据库函数、计算表达式等等，查询时要尽可能将操作移至等号右边。
