代码走查报告(模板)

代码走查
一．代码走查的目的
1．保证代码符合编码规范
2．保证代码符合设计
3．发现bug
4．保证代码单元测试充分
5．促进开发人员之间的交流，为代码的优秀程度的提高和开发人员编码技能的提高提供契机。

二．过程
每次迭代都要对修改过和新编的代码进行走查，走查的过程如下图：
三．Checklist
说明：本checklist用于走查人员走查代码。

开发人员用于自我检查的checklist可以参照此checklist，依自身实际情况制定。

说明：本checklist应随着组织开发过程中出现的实际情况，对检查项具体内容进行增、删、改，以使得此checklist更具效率，但要注意保持检查项数目的简洁。

类名：走查的类的名字。

代码走查检查表评审日期：年月日评审对象作者评审人评审工作量序号检查项评审意见走查前准备1 得到一份解释代码的最新的设计文档，作为代码走查的参考2 代码都已提交，版本统一程序结构组织1 所有代码的结构清晰，具有良好的结构外观和整齐2 所有的模块（函数和外部接口）定义清晰，模块分解清楚3 所有的功能需求都明显的覆盖4 整个代码体系结构组合合理 ,分层清晰，代码之间功能划分明确5 所有的接口模块化，尽量减少接口之间的耦合度，修改时尽量不影响其他代码模块6 代码体系构架对空间和速度都已经进行考虑7 数据库操作、IO操作等是否正确关闭资源。

并且必须在try -catch-finally 的finally中关闭。

8 一个业务如果进行多次数据库更新、添加、删除是否正确添加事务。

9 进行逻辑与、逻辑或判断时是否使用短路与、短路或。

10 多处使用相同代码时，应定义唯一方法或变量以供使用。

11 对象是否使用工厂获取。

12 导入类时，如果仅使用包中的几个类，应导入具体类，而不是导入整个包。

13 数组声明的时候使用 int[] index ，而不要使用int index[]。

14 代码实现的逻辑是否与详细设计描述的逻辑一致15 检查类中是否有无效的代码或者是无用的代码。

16 不要使用System.out.print()以及System.err输出，需要进行日志处理17 所有的文件名符合文件命名规范，见名知意18 文件和模块分组清晰19 较长的语句、表达式或参数（>80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读20 每个程序文件都小于2000行代码组织1 数据库查询语句不要出现select *2 对需要处理的字符串定义为StringBuffer ，常量定义成静态的。

3 所有的变量名都小于32字符4 有返回值的方法是否正确返回。

Return语句应定义在方法结尾处。

C++代码⾛查CheckList
代码⾛查
⼀．代码⾛查的⽬的
1．保证代码符合编码规范
2．保证代码符合设计
3．发现bug
4．保证代码单元测试充分
5．促进开发⼈员之间的交流，为代码的优秀程度的提⾼和开发⼈员编码技能的提⾼提供契机。

⼆．过程
每次迭代都要对修改过和新编的代码进⾏⾛查，⾛查的过程如下图：
三．Checklist
说明：本checklist⽤于⾛查⼈员⾛查代码。

开发⼈员⽤于⾃我检查的checklist可以参照此checklist，依⾃⾝实际情况制定。

说明：本checklist应随着组织开发过程中出现的实际情况，对检查项具体内容进⾏增、删、改，以使得此checklist更具效率，但要注意保持检查项数⽬的简洁。

类名：⾛查的类的名字。

代码检查摘要：代码检查是白盒测试的一种静态测试方法,是众多软件测试方法中发现软件缺陷最有效的方法之一。

本文结合国内外学者在相关领域的研究情况,介绍代码检查相关的基本概念、过程和分析方法。

关键字:白盒测试，代码检查，静态分析，检查规则一、引言按照测试时源代码是否可见，软件测试可以分为白盒测试和黑盒测试两类。

白盒测试（结构测试），即逻辑驱动的测试,是在了解程序内部结构的基础上，对程序的逻辑结构进行检查,从中获取测试数据.白盒测试关注的是测试用例执行的程度或覆盖程序逻辑结构的程度。

白盒测试一般只应用于软件开发阶段。

白盒测试，又可按照是否需要运行程序，进一步细分为了静态测试和动态测试两种。

通常情况下是按照先静态后动态测试顺序来实施。

其中，静态测试包括代码检查、静态结构分析、代码质量度量等测试内容。

静态测试既可以由人工进行，充分发挥人的逻辑思维优势，也可以借助软件工具自动进行.代码检查是一种对程序代码进行静态检查。

传统的代码检查是通过人工阅读代码的方式，检查软件设计的正确性；用人脑模拟程序在计算机中的运行，仔细推敲、校验和核实程序每一步的执行结果，进而判断其执行逻辑、控制模型、算法和使用参数与数据的正确性.在实践中，代码检查比动态测试更有效率，能找到更多的缺陷,通常能发现30%～70%的逻辑设计和编码缺陷.代码检查非常耗费时间，而且需要专业知识和经验的积累.代码检查定位在编译之后和动态测试之前进行,在检查前，应准备好需求描述文档、程序设计文档、程序的源代码清单、代码编码标准和代码缺陷检查表等.代码检查可以发现的软件问题包括：声明或引用错误、函数/方法参数错误、语句不可达错误、数组越界错误、控制流错误、界面错误和输入/输出错误等。

1、代码检查代码检查包括桌面检查、代码走查和代码审查等方式,主要检查代码和设计的一致性，代码对标准地遵循、可读性，代码逻辑表达的正确性,代码结构的合理性等方面；发现违背程序编写标准的问题，程序中不安全、不明确和模糊的部分，找出程序中不可移植部分、违背程序编程风格的问题，包括变量检查、命名和类型检查、程序逻辑检查、程序语法检查和程序结构检查等内容。

编号：NC-GS-IV-CWR版本：v1.0阶段标注：DEnjoy Your Product代码走查记录vx.y《XXX项目》编制：审核：标审：会签：批准：XX有限公司2019年XX月更改历史页目录代码走查记录表 (1)附录：文档模板说明 (7)代码走查记录表开发人员：评审日期：年月日代码走查记录表开发人员：评审日期：年月日代码走查记录表开发人员：评审日期：年月日代码走查记录表开发人员：评审日期：年月日代码走查记录表开发人员：评审日期：年月日代码走查记录表开发人员：评审日期：年月日开发组长：检查人：附录：文档模板说明1级标题字体：微软雅黑加粗二号格式段落：多倍行距设置值 3 其他0 2级标题字体：微软雅黑加粗小二格式段落：多倍行距设置值 3 其他0 3级标题字体：微软雅黑加粗三号格式段落：多倍行距设置值 3 其他0 4级标题字体：微软雅黑加粗小三格式段落：多倍行距设置值 3 其他0 5级标题字体：微软雅黑加粗四号格式段落：多倍行距设置值 3 其他0 6级标题字体：微软雅黑加粗小四格式段落：多倍行距设置值 3 其他0 7级标题字体：微软雅黑加粗小四格式段落：多倍行距设置值 3 其他08级标题字体：微软雅黑加粗小四格式段落：多倍行距设置值 3 其他09级标题字体：微软雅黑加粗五号格式段落：多倍行距设置值 3 其他0正文格式：字体：微软雅黑小四格式段落：首行缩进2字符 1.5倍行距表格内文字格式：表格标题：微软雅黑加粗五号表格标题底纹颜色：灰色色值：红黄蓝数值均为217表格正文：微软雅黑五号正文样例文字编写格式：字体：微软雅黑斜体五号表格标题底纹颜色：灰色色值：红黄蓝数值均为64格式段落：首行缩进2字符 1.5倍行距8/ 12页眉页码格式：封面格式：无页码无页眉文档更新记录页至目录页格式：有页眉有页码页码设置为罗马数字：ⅠⅡⅢ页面低端居中位置文档正文格式：有页眉有页码页码设置为阿拉伯数字页面低端居中位置并显示当前页和总页数。

走查前准备1 得到一份解释代码的最新的设计文档2 代码解释时使用了严格的警告和错误检查参数并被解释通过3 代码使用带ISO标准的xxxx编译器进行解释程序结构4 所有代码的结构清晰，具有良好的结构外观和整齐5 所有的模块（函数和外部接口）定义清晰，模块分解清楚6 所有的功能需求都明显的覆盖7 高层设计独立于OS/环境8 结构设计能够满足机能变更9 代码体系结构描述了如何把代码重用到其他体系结构中10 整个代码体系结构组合合理11 所有主要的数据构造描述清楚，合理12 模块中所有的数据结构都定义为局部的，并且通过定义好的函数进行访问13 为外部定义了良好的函数接口14 所有的接口模块化，因此修改时不影响其他代码模块15 内存使用方法和内存管理策略描述清楚和正确16 代码体系构架对空间和速度都已经进行考虑17 提供了处理数据的策略18 具有同一的错误处理策略19 通过一套清晰的函数接口提供错误信息目录文件组织20 所有的文件名符合文件命名规范，见名知意21 文件和模块分组清晰22 每个文件有文件头和标准的习惯一致（描述文件的用途，作者，对外提供的函数）23 每个文件都组织的有序－文件头，类型定义，原型，函数24 所有的代码行在80字符以内25 每个程序文件都小于2000行26 每个文件只包含一个完整功能模块的代码函数组织27 每个函数都有一个标准的函数头声明28 函数组织：头，函数名，参数，函数体29 函数定义符合ANSI或者用标准PERL的编译开关30 每个函数都能够在最多2页纸可以打印31 所有的变量声明每行只声明一个32 所有的函数名都小于64个字符33 每个函数之间都用2空行进行分开代码组织34 每行代码都小于80字符35 所有的变量名都小于32字符36 所有的行每行最多只有一句代码或一个表达式37 复杂的表达式具备可读性38 续行缩进39 括号在合适的位置40 每个顺序的小块用空行隔开41 注解和代码对齐或接续在代码之后移植性42 代码与操作系统无关，不需要任何假设条件函数43 函数头清楚地描述函数和它的功能44 代码中有相关注解45 函数的名字清晰的定义了它的目标以及函数所做的事情46 函数的功能清晰定义47 函数中所有的部分都合理的组成函数，相关独立的语句组组成函数48 函数高内聚只做一件事情，并做好49 函数和其他代码松耦合50 参数遵循一个明显的顺序；51 所有的参数都被使用52 函数的参数接口关系清晰53 如果一个函数有返回值，在所有的出口都有返回值54 函数使用了最少数目的return语句55 函数的参数个数小于7个56 所有的假设和接口清楚57 使用的算法说明清楚58 函数检查了输入数据的合法性59 函数异常处理清楚60 函数设计已经考虑了将来的变化61 调试信息存在于代码中并容易激活62 代码检查调用函数的返回值，参数和调用匹配63 函数确保了没有影响函数外代码64 递归定义了出口65 递归局限于一个函数66 堆栈大小支持递归调用的深度数据类型与变量67 数据类型存在数据类型解释68 代码为每种可能改变数据类型的数据使用一个不同的类型69 代码避免了重新定义预先定义的数据类型70 数据结构简单以便降低复杂性71 每一种变量分配了正确的长度、类型和存储空间72 静态变量明确区分73 所有的声明与编译器或具体的机器长度无关74 每一个变量都初始化了75 每一个变量都在接近使用它的地方才初始化76 每一个变量都在将要使用它的时候才初始化77 变量的命名完全、明确的描述了该变量代表什么78 命名和现实生活中的事务接近而不仅仅是一个程序类型79 同一种类型或指针命名的前缀指出类型或指针80 命名不与标准库中的命名相冲突81 程序没有使用特别的、易误解的、发音相似的命名82 所有的变量都有最小的活动范围83 所有的全局变量都描述清楚84 使用函数访问取代全局数据的访问85 所有的变量都用到了86 存取数据的程序与全局数据的用法是兼容的87 变量按照它的命名用途进行使用特殊88 所有的数组访问在它们的边界内89 代码已经处理了-1错误90 代码处理了指针异常91 所有常量定义和使用替代代码中的数字92 类型转换明确指明其他注意项93 代码与比较，计算变量的大小无关94 代码与操作符的优先级无关95 所有的表达式使用了正确的操作符条件判断96 条件检查和结果在代码中清晰97 If/else 使用正确98 普通的情况在if下处理而不是else99 判断的次数降到最小100 判断的次数不大于6次，无嵌套的if链101 数字，字符，指针和0/NULL/FLSE 判断明确102 boolen表达式表示清楚103 最常用的情况最先判断104 所有的情况都考虑105 判断体足够短，以使得一次可以看清楚106 嵌套层次小于3次循环107 循环体不为空108 循环之前做好初始化代码109 循环体能够一次看清楚110 当有明确的多次循环操作，使用For循环111 当有不明确的多次循环操作，while循环被使用112 代码中不存在无穷次循环113 循环的头部进行循环控制114 循环索引具有有意义的命名115 循环设计得很好它，只干一件事情116 循环终止的条件清晰117 循环体内的循环变量起到指示作用118 循环嵌套的次数小于3次输入输出119 所有文件的属性描述清楚120 所有OPEN/CREATE调用描述清楚121 文件结束的条件进行检查122 显示的文本无拼写和语法错误注释123 有一个简单的说明，用于描述代码的结构124 每个文件和模块均以给予解释125 源代码能够自我解释126 每个人看到代码就能很快理解127 解释说明代码功能，准确描述代码意义128 解释不过于简单129 注解清楚正确130 注解为用户服务131 所有的假设和限制进行注解132 长的控制体结束，进行注解总括133 代码直观134 代码中的用语符合广告用语，而不是技术化的描述135 代码和设计文档对应136 无用的代码已经删除137 无用的注解已经删除。