代码走查报告(模板)

合集下载

C__代码走查CheckList

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

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

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

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

类名：走查的类的名字。

【软件工程】【CMMI】代码走查单

1-14
用应通该配尽符可方能式减小类与类之间耦合，所遵循的经验法则是：尽量限制成员函数的可见性。如果成员函数没必要
1-15
为若保没护有足(够pr理ot由ec，te不d)要；把没实必例要或保类护变(量pr声ot明ec为te公d)有，。就公定共义和为保私护有的(可pr见iv性at应e)当。尽量避免，所有的字段都建议
1-3
避免使用长名字（最好不超过 25 个字母）
1-4
采用大小写混合，提高名字的可读性。一般应该采用小写字母，但是类和接口的名字的首字母，以及任何中
1-5
所写有。单包词名首全字部母小大写写。。使用能确切反应该类、接口含义、功能等的词。一般采用名词
1-6
采用完整的英文大写单词，在词与词之间用下划线连接，如：DEFAULT_VALUE
代码走查记录跟踪单
项目名称
记录更新人
记录更新时间
走期模块名称
检查文件代码总行数（个）数（LOC）
花费工时（H）
1
50000
2
50000
3
50000
编号
检查项
1 代码规范
1-1
程序结构清晰，简单易懂，单个函数行数不得超过100行；
1-2
使用可以准确说明变量/字段/类/接口/包等的完整的英文描述符
1-7
对不易清楚识别出该变量类型的变量应使用类型缩写作其前缀，如字符串使用strXXX,boolean使用isXXX。
1-8
应采用完整的英文描述符命名组件（接口部件），遵循匈牙利命名法则
1-9
一个集合，例如数组和矢量，应采用复数命名来表示队列中存放的对象类型。命名应采用完整的英文描述符

[指南]代码走查检查表

代码走查检查表评审日期：年月日评审对象作者评审人评审工作量序号检查项评审意见走查前准备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语句应定义在方法结尾处。

代码走查表

5
□ 不符合 □ 不符合 □ 不符合 □ □ □ □ □ □ □ □ □ 不符合不符合不符合不符合不符合不符合不符合不符合不符合
□ 基本符合 □ 基本符合 □ 基本符合 □ □ □ □ □ □ □ □ □ 基本符合基本符合基本符合基本符合基本符合基本符合基本符合基本符合基本符合
2
新增按钮必须排列在通用按钮之后，退出按钮之前。新增按钮必须有MDI帮助和说明。数据窗的行高68、单元格高度为56，行线颜色border(none)、背景白色（white）；列表式数据窗一般为Grid，数据窗的字体“宋体 9”，数据窗Header高68、标签（Text）高56，背景为灰色（ButtonFace），平面（No border）按钮（CommandButton）按钮的大小长度：334，高度：88 其他控件 StaticText、SinglelineEdit、EditMask的高度为72 全部采用默认样式（3D），以统一界面为标准。长宽比例要求一致，建议采用黄金比例法弹出的层数不能超过3个，并且保证是响应式窗口同类型的窗口保持布局一致代码走查人签字： QA人员签字：
■ 符合 ■ 符合 ■ 符合 ■ ■ ■ ■ ■ ■ ■ ■ ■ 符合符合符合符合符合符合符合符合符合
6
□ □ □ □ □ □ □ □ □ □ □ □ □ □ □ □ □ □ □ □ □ □ □ □ □ □ □ □ □ □ □ □ □ □ □ □ □
基本符合基本符合基本符合基本符合基本符合基本符合基本符合基本符合基本符合基本符合基本符合基本符合基本符合基本符合基本符合基本符合基本符合基本符合基本符合基本符合基本符合基本符合基本符合基本符合基本符合基本符合基本符合基本符合基本符合基本符合基本符合基本符合基本符合基本符合基本符合基本符合基本符合

C++代码走查CheckList

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

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

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

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

类名：⾛查的类的名字。

HLSD-CIM-代码走查报告

来说，系统代码基本符合编码规范。
NA 不适用状态 P P P P P P P P P P P P P P P P P P P P P P P P P P P P P P P P P P P P P 说明
编程-输入、输出错误
编程-条件判定编程-传送编程-处理遗漏冗长
1 1 1 2 1 2 3 4 5
条件、分支等在逻辑上是否矛盾双方的位数、属性是否合适必要的逻辑运算（演算、判定、变换等），是否有遗漏的步骤是否有多余的逻辑运算、步骤更新的对象是否被删除了收集用的类是否被删除了禁止使用或者使用限制的命令是否被使用从实行速度看，命令、逻辑运算是否恰当调用API等组合的方法时，参数、返回值是否合适是否遵循了编码规范是否遵循了结构设计是否遵循了SQL编码指针程序内所有路径的确认分支是否有遗漏构成程序模块的界面的确认对文件/数据库表的确认对输入数据的检查、演算处理的确认根据输入数据对输出数据的确认（模拟）反应的确认（只是画面系程序，按纽按下时，5秒钟以上没有反应要提类的继承、保护是否存在问题风格是否统一是否成为了线形、单纯、同型、对象风格例外处理是否有遗漏
注：每种评审检查表不同，参考OSSP检查表,根据具体情况可以添加或修改检查项
代码检查表
项目名称检查日期检查人员检查项状态标记类别 No. 1 2 编程-数据调用 3 4 5 1 2 编程-数据定义 3 4 5 6 1 2 编程-计算错误 3 4 5 6 7 1 2 编程-比较错误 3 4 5 1 2 编程-控制流程 3 4 5 1 编程-界面 2 3 4 1 2 3 4 5 CIM客服信息管理系统 2011-6-17 康瑞伟、刘树强、杨洲 P 合格 O 不合格 TBD 待完成主要检查项下标值是否在限定范围内参照用的指针、变量等是否被分配了使用空间从多个方法看，被参照的数据结构是否有矛盾有没有超出字符串范围的可能性下标的操作中是否有遗漏变量、对象是否被初期化变量没有被初始化时，是否有缺省值引用方法中，没有被指定参数时，是否有缺省值数组、字符串等的定义是否恰当各种变量的上限值和下限值是否恰当属性和精度是否合适没有数字的变量是否计算了不同类型的变量计算时，是否遵循了变换规则计算的结果是否超过了使用变量的范围最终结果的位数虽然没有超出，但在计算过程中，是否有超出的可能性是否有被0除的可能性四则运算的优先顺序是否有误是否有丢失了的位数变量之间的比较是否有矛盾不同类型之间进行比较时，是否遵循了变换规则类似于[更大]、[以上]的错误是否被实装是否有逻辑上的书写错误。例如：I 比X或Y大，I>X|Y的错误是否掌握了AND、OR、NOT的优先顺序是否有遗漏分支的情况循环的终止条件是否合适循环的终止条件有多个时，其优先顺序是否合适进入循环前，各变量的初始值是否合适方法的使用是否没有终止保存方法的返回值的变量类型是否合适调用方法的参数是否被更新，如果更新了，是否合适内部变量是否被当作外部方法调用被参照的变量在所有方法中的定义和属性是否一致文件被明确定义时，其属性是否合适打开文件的属性是否正确所有的文件在被使用前，是否被打开文件关闭状态被正确处理了否 I/O错误状态是否被正确纠正

代码检查【范本模板】

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

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

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

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

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

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

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

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

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

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

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

D7-XX项目-代码走查记录-yyyymmd

编号：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、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。

代码审核问题报告
文档标识：
当前版本：
当前状态：
草稿
发布日期：
发布
修改历史
日期
版本
作者
修改内容
评审号
变更控制号
评审对象：评审日期：
问题
是
否，指出问题所在或解释理由
总体
代码编制是否遵照编码规范
缺陷修改是否完全完成
ቤተ መጻሕፍቲ ባይዱ所有的代码是否风格保持一致
注释
所有的注释是否是最新的
所有的注释是清楚和正确
若代码修改注释是否很方便修改
所有代码异常处理是否都有注释
每一功能目的是否都有注释
是否按注释类型格式编写注释
代码注释量是否达到了规定值
源代码质量
所有变量的命名是否依照规则
循环嵌套是否优化到最少
所有代码是否易懂
所有设计要求是否都实现
其它(根据情况添加)
开发组长：检查人：