代码走读检查表模板
合集下载
相关主题
- 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。
2
注释
重要
3
注释
重要
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
注释 注释 注释 注释
重要 重要 中等 重要
注释是否较清晰且必要? 复杂的分支流程是否已经被注释? 距离较远的}是否已经被注释? 方法是否已经有文档注释?(功能、输入、返回及其他可 选) 每行是否只声明了一个变量?(特别是那些可能出错的类 型) 变量是否已经在定义的同时初始化? 是否合理地使用了空格使程序更清晰? 代码行长度是否在要求之内?(建议每行不超过80个字符) 折行是否恰当? 包含复合语句的{}是否成对出现并符合规范? 是否给单个的循环、条件语句也加了{}? 单行是否只有单个功能?(不要使用;进行多行合并) 单个函数是否执行了单个功能并与其命名相符? 单个函数不超过规定行数?每个函数不能超过300行 入口对象是否都被进行了判断不为空?
代码检查列表
序号 1 所属类别 命名 重要程度 重要 检查项 命名规则是否与所采用的规范保持一致? 所有的源文件都应该在开头有一个版权和文件内容声明 /* *Model:模块名称 *Description:文件描述 *Author:作者姓名(一般情况下用中文) *Finished:xxxx年xx月xx日 */ 在导入包时当完全限制代码所使用的类的名字,而不用通配符 的方式 例如: import java.awt.Color; import java.awt.Button;
声明、空白、缩进 重要 声明、空白、缩进 重要 声明、空白、缩进 中等 声明、空白、缩进 中等 声明、空白、缩进 中等 逻辑 逻辑 逻辑 逻辑 逻辑 逻辑 重要 中等 重要 重要 中等 重要
19 20 21 22 23
逻辑 逻辑 逻辑 逻辑 逻辑
重要 重要 重要 重要 重要
源自文库
是否对有异常抛出的方法都执行了try...catch保护? 入口对象是否都被进行了判断不为空? 入口数据的合法范围是否都被进行了判断?(尤其是数组) 是否对有异常抛出的方法都执行了try...catch保护? 是否对方法返回值对象做了null检查,该返回值定义时是否 被初始化?
其他评审意见或建议:
评审意见 (具体意见描述)
评审人
责任人