代码检查表
合集下载
(完整word版)重点代码检查表
2.ServiceApplyDeal.saveApplyDealData（） 服务申请处理信息必须包含环节实例ID，如果该值为空，抛出异常。（各开发人员调用此方法，请注意传入环节实例ID）
2、ServiceApplyDeal.saveApplyDealData（） 服务申请处理信息必须包含环节实例ID，如果该值为空，抛出异常。（各开发人员调用此方法，请注意传入环节实例ID）
2、问题申请页面，选择服务类别未传busyflowtype参数
已修改
变更管理
叶海龙
王海峰
2006.08.28
2006.08.29
1.变更申请页面JSP需要调整, 注意与事件申请页面的不同
2、变更无服务等级, init_apply和view_apply方法需要去除查询服务等级的相关代码
正在修改
计划任务
正在修改
资产配置
叶海龙
王海峰
2006.08.28
2006.08.29
1.修改了AIB生成的DAO相关方法代码,破坏了对象的原子性操作。
2、直接调用DAO的方法,连接未释放,造成整个系统无法获取可用数据库连接
2.直接调用DAO的方法，连接未释放，造成整个系统无法获取可用数据库连接
2、直接调用DAO的方法，连接未释放，造成整个系统无法获取可用数据库连接
2.JSP页面嵌入太多业务逻辑代码，难以阅读，需要整理，放入JAVA类中
2、JSP页面嵌入太多业务逻辑代码，难以阅读，需要整理，放入JAVA类中
正在修改
由caseid找对应的关联, 应该综合考虑表relate_caseid的CASEID和RELATE_CASEID两个字段
2、ServiceApplyDeal.saveApplyDealData（） 服务申请处理信息必须包含环节实例ID, 如果该值为空, 抛出异常。（各开发人员调用此方法, 请注意传入环节实例ID）
2、ServiceApplyDeal.saveApplyDealData（） 服务申请处理信息必须包含环节实例ID，如果该值为空，抛出异常。（各开发人员调用此方法，请注意传入环节实例ID）
2、问题申请页面，选择服务类别未传busyflowtype参数
已修改
变更管理
叶海龙
王海峰
2006.08.28
2006.08.29
1.变更申请页面JSP需要调整, 注意与事件申请页面的不同
2、变更无服务等级, init_apply和view_apply方法需要去除查询服务等级的相关代码
正在修改
计划任务
正在修改
资产配置
叶海龙
王海峰
2006.08.28
2006.08.29
1.修改了AIB生成的DAO相关方法代码,破坏了对象的原子性操作。
2、直接调用DAO的方法,连接未释放,造成整个系统无法获取可用数据库连接
2.直接调用DAO的方法，连接未释放，造成整个系统无法获取可用数据库连接
2、直接调用DAO的方法，连接未释放，造成整个系统无法获取可用数据库连接
2.JSP页面嵌入太多业务逻辑代码，难以阅读，需要整理，放入JAVA类中
2、JSP页面嵌入太多业务逻辑代码，难以阅读，需要整理，放入JAVA类中
正在修改
由caseid找对应的关联, 应该综合考虑表relate_caseid的CASEID和RELATE_CASEID两个字段
2、ServiceApplyDeal.saveApplyDealData（） 服务申请处理信息必须包含环节实例ID, 如果该值为空, 抛出异常。（各开发人员调用此方法, 请注意传入环节实例ID）
代码评审检查表模板
不适用 优秀 合格 不合 格
10 11 12 13 建议:
备注
Hale Waihona Puke 代码评审检查表 序号1 2 3 4 5 6 7 8
9
检查项 是否存在不可执行码和冗余码? 注释说明是否完整? 程序逻辑是按照需求的吗? 是否存在内存泄露或死锁? 算法执行是否正确? 变量定义是否合理? 最大，最小数据值的边界充分吗? 可移植性被考虑了吗? 当Bug修改时, 是否有充足的注释说明: 1. 变更作者 2. 变更日期 3. Bug号 4. 相关联files，source代码 编码标准和规则被遵照了吗? 是否进行了一致性校验: 所有文件(设计、需求说明 、 项目计划, SCM 计划、SQA计划、测试计划等) 是否被 更新以和最新的代码保持一致, 特别当有设计或需求变 动? 该项工作的计划与实际成本是否合理？ 该项工作的计划与实际进度是否合理？
代码走查检查表
4
整个代码体系结构组合合理,分层清晰，代码之间功能划分明确
5
所有的接口模块化，尽量减少接口之间的耦合度，修改时尽量不影响其他代码模块
6
代码体系构架对空间和速度都已经进行考虑
7
数据库操作、IO操作等是否正确关闭资源。并且必须在try -catch-finally 的finally中关闭。
8
一个业务如果进行多次数据库更新、添加、删除是否正确添加事务。
9
进行逻辑与、逻辑或判断时是否使用短路与、短路或。
10
多处使用相同代码时，应定义唯一方法或变量以供使用。
11
对象是否使用工厂获取。
12
导入类时，如果仅使用包中的几个类，应导入具体类，而不是导入整个包。
13
数组声明的时候使用 int[] index ，而不要使用 int index[]。
14
代码实现的逻辑是否与详细设计描述的逻辑一致
21
异常要统一处理，异常处理方法是否符合项目组的约定
22
在Action中不要过多的逻辑处理代码
23
不要出现魔鬼数字
24
检查可能出现空指针异常的地方，例如一个对象可能为空，却调用它的方法或属性。
25
显示的文本无拼写和语法错误
26
所有的表达式使用了正确的操作符
函数组织
1
所有的函数名都小于64个字符
2
函数高内聚 尽量只做一件事情，并做好
7
复杂的表达式具备可读性，添加注释说明，表达式结构清晰
8
续行缩进
9
括号在合适的位置
10
每个顺序的小块用空行隔开
11
注释和代码对齐或接续在代码之后
12
JSP必须不能有basepath。
整个代码体系结构组合合理,分层清晰，代码之间功能划分明确
5
所有的接口模块化，尽量减少接口之间的耦合度，修改时尽量不影响其他代码模块
6
代码体系构架对空间和速度都已经进行考虑
7
数据库操作、IO操作等是否正确关闭资源。并且必须在try -catch-finally 的finally中关闭。
8
一个业务如果进行多次数据库更新、添加、删除是否正确添加事务。
9
进行逻辑与、逻辑或判断时是否使用短路与、短路或。
10
多处使用相同代码时，应定义唯一方法或变量以供使用。
11
对象是否使用工厂获取。
12
导入类时，如果仅使用包中的几个类，应导入具体类，而不是导入整个包。
13
数组声明的时候使用 int[] index ，而不要使用 int index[]。
14
代码实现的逻辑是否与详细设计描述的逻辑一致
21
异常要统一处理，异常处理方法是否符合项目组的约定
22
在Action中不要过多的逻辑处理代码
23
不要出现魔鬼数字
24
检查可能出现空指针异常的地方，例如一个对象可能为空，却调用它的方法或属性。
25
显示的文本无拼写和语法错误
26
所有的表达式使用了正确的操作符
函数组织
1
所有的函数名都小于64个字符
2
函数高内聚 尽量只做一件事情，并做好
7
复杂的表达式具备可读性，添加注释说明，表达式结构清晰
8
续行缩进
9
括号在合适的位置
10
每个顺序的小块用空行隔开
11
注释和代码对齐或接续在代码之后
12
JSP必须不能有basepath。
代码验收条件检查表
验收文档 代码说明文档 操作手册 部署文档
交付方所编写的需求文档、设计文档、功能清单、业务流程图（可包含在设计文档）、业务 架构图（可包含在设计文档）、开发帮助手册、部署安装配置手册等项目过程文档，详情见 附件“项目内验所需资料V1.0.doc”。 必须包括所提交的代码地址、代码清单和模块结构说明、代码的说明(各工程间的关联、运 行顺序、运行环境配置等)等信息，以doc或pdf格式提供，参考“附件6：代码结构说明文档 示例.docx”。
事项
是否符合
代码验收条件检系统，系统包括的功能及功能的说明，功能清单必须覆盖系统的所有功能。 功能清单以Excel表格的方式提供，参考“附件3：系统功能清单参考示例.xlsx”。
性能指标
根据合同要求，所明确的相关性能指标，若合同中无要求，参照我司与业主的合同等相关确 认文件作为指标。性能指标以doc或pdf格式提供。
项目所有功能有明确的操作说明，接收方或用户可根据操作手册完成操作。
包括开发环境部署文档、测试环境部署文档及生产环境部署文档。
以上事项必须全部符合。
测试用例
交付方所进行测试的所有测试用例，作为交付方执行测试工作的依据，以doc或pdf格式提 供，参考“附件5：系统测试用例示例.docx”。
测试报告
交付方所编写的测试报告且报告中明确结果：测试通过(功能测试、性能测试等)，作为交付 方已完成自检并未检出问题的依据，以doc或pdf格式提供，按“附件4：系统测试报告模 版.doc”模版编写。
车辆售前检查表PDI
售前车辆检查表
检查序号： 车辆编号 发动机号 车型代码 检查日期 车辆颜色 合格证号 车型名称 □顶灯、车内灯、行车照明灯 □行车照明灯开关 □危险警告灯 □防雾灯 □仪表板灯(全部) □牌照灯(全部) 检查所有灯光 □遮阳板/内视镜灯 □尾灯 □后备箱/货舱区灯 □转向信号指示灯 □警示灯(机油压力、预热、电瓶、驻车制 动及制动液位、水分离器、冷却水位) 检查控制结构 □音响、时钟设定和收放机功能 □空调控制结构(驾驶座、乘客做、后座)(暖风机 、空调器、除霜器) □门锁(手动、电动) □发动机舱盖、后备箱盖、后舱盖/尾门和燃油箱 盖打开装置(电动、手动) □喇叭 □转向柱锁定 □点烟器 □倒车镜 □驻车制动器 □座椅安装完好性 □安全带(前后) □靠背插销 □车门开启正常 □空调工作状况 □电瓶完好 □制动管路不漏油 检查发动机舱盖 □风扇及空调皮带紧张力 下的机构功能 □电气装置、导线及真空接头软管的磨损 □发动机运转状况(静态发动) □燃油管路不漏油 □变速器润滑油不渗漏 □前后桥润滑油不渗漏 □对正前大灯 □检查车门、发动机、后备箱盖和尾门检查 □检查所有钥匙 □检查所有地毯、车内附件 □检查车轮螺母拧紧情况 外观总体检查 □前保险杠下部机件状况 □彻底清洗车内外 □检查漆面 □提供保修手册、使用说明书、合格证 □检查风挡和车窗(侧、后部)(电动、手动) □检查随车工具 □已摘除雨刮护套 技术(检查)人员 客户: 试车 □变速器操作性能正常 冷热启动正常 □仪表(水温、机油压力、燃油、里程表、车速表) 显示正常 □离合器功能 □转向和动力转向正常 □加速性能 □空调及通风控制结构正常 □制动功能 检查和加注油液 □发动机冷却液 □发动机机油 □动力转向液 □制动液 □轮胎/胎压(包括备胎)的规格及破损 □前后风挡清洗液(冬季使用添加剂) 年 月 日 底盘号 所在库位
检查序号： 车辆编号 发动机号 车型代码 检查日期 车辆颜色 合格证号 车型名称 □顶灯、车内灯、行车照明灯 □行车照明灯开关 □危险警告灯 □防雾灯 □仪表板灯(全部) □牌照灯(全部) 检查所有灯光 □遮阳板/内视镜灯 □尾灯 □后备箱/货舱区灯 □转向信号指示灯 □警示灯(机油压力、预热、电瓶、驻车制 动及制动液位、水分离器、冷却水位) 检查控制结构 □音响、时钟设定和收放机功能 □空调控制结构(驾驶座、乘客做、后座)(暖风机 、空调器、除霜器) □门锁(手动、电动) □发动机舱盖、后备箱盖、后舱盖/尾门和燃油箱 盖打开装置(电动、手动) □喇叭 □转向柱锁定 □点烟器 □倒车镜 □驻车制动器 □座椅安装完好性 □安全带(前后) □靠背插销 □车门开启正常 □空调工作状况 □电瓶完好 □制动管路不漏油 检查发动机舱盖 □风扇及空调皮带紧张力 下的机构功能 □电气装置、导线及真空接头软管的磨损 □发动机运转状况(静态发动) □燃油管路不漏油 □变速器润滑油不渗漏 □前后桥润滑油不渗漏 □对正前大灯 □检查车门、发动机、后备箱盖和尾门检查 □检查所有钥匙 □检查所有地毯、车内附件 □检查车轮螺母拧紧情况 外观总体检查 □前保险杠下部机件状况 □彻底清洗车内外 □检查漆面 □提供保修手册、使用说明书、合格证 □检查风挡和车窗(侧、后部)(电动、手动) □检查随车工具 □已摘除雨刮护套 技术(检查)人员 客户: 试车 □变速器操作性能正常 冷热启动正常 □仪表(水温、机油压力、燃油、里程表、车速表) 显示正常 □离合器功能 □转向和动力转向正常 □加速性能 □空调及通风控制结构正常 □制动功能 检查和加注油液 □发动机冷却液 □发动机机油 □动力转向液 □制动液 □轮胎/胎压(包括备胎)的规格及破损 □前后风挡清洗液(冬季使用添加剂) 年 月 日 底盘号 所在库位
代码评审标准与结果
6
注释对于理解代码是否有帮助
7
代码中的注释是否充分
8
代码中的注释是否过多
布局/封装缺陷
1
代码布局风格和缩排标准是否前后一致并体现其逻辑结构
2
代码中是否存在已被注释且不再使用的代码
3
复杂程序是否合理地分解成多个子程序
4
每个方法的代码量是否都不超过60行
5
方法或类之间是否具有低耦合性
6
方法或类之间是否具有高内聚性
2
比较运算符是否正确
3
布尔表达式是否通过内部否定操作进行了简化
4
每个布尔表达式是否都正确
5
比较操作是否存在不引人注意的副作用
6
是否存在“&&”替换为“&”或“||”替换为“|”的情况
7
代码中是否避免了对浮点型数值的相等比较操作
流程控制缺陷
1
每个循环是否选用了最佳循环结构
2
所有的循环结束条件是否明显
3
6
注释对于理解代码是否有帮助
7
代码中的注释是否充分
8
代码中的注释是否过多
布局/封装缺陷
1
代码布局风格和缩排标准是否前后一致并体现其逻辑结构
2
代码中是否存在已被注释且不再使用的代码
3
复杂程序是否合理地分解成多个子程序
4
每个方法的代码量是否都不超过60行
5
方法或类之间是否具有低耦合性
6
方法或类之间是否具有高内聚性
7
是否存在重复代码且它的功能可以通过调用其他方法实现
8
方法参数数量是否控制在5个以内
性能/算法缺陷
1
是否存在更好的数据结构和算法可以采用
注释对于理解代码是否有帮助
7
代码中的注释是否充分
8
代码中的注释是否过多
布局/封装缺陷
1
代码布局风格和缩排标准是否前后一致并体现其逻辑结构
2
代码中是否存在已被注释且不再使用的代码
3
复杂程序是否合理地分解成多个子程序
4
每个方法的代码量是否都不超过60行
5
方法或类之间是否具有低耦合性
6
方法或类之间是否具有高内聚性
2
比较运算符是否正确
3
布尔表达式是否通过内部否定操作进行了简化
4
每个布尔表达式是否都正确
5
比较操作是否存在不引人注意的副作用
6
是否存在“&&”替换为“&”或“||”替换为“|”的情况
7
代码中是否避免了对浮点型数值的相等比较操作
流程控制缺陷
1
每个循环是否选用了最佳循环结构
2
所有的循环结束条件是否明显
3
6
注释对于理解代码是否有帮助
7
代码中的注释是否充分
8
代码中的注释是否过多
布局/封装缺陷
1
代码布局风格和缩排标准是否前后一致并体现其逻辑结构
2
代码中是否存在已被注释且不再使用的代码
3
复杂程序是否合理地分解成多个子程序
4
每个方法的代码量是否都不超过60行
5
方法或类之间是否具有低耦合性
6
方法或类之间是否具有高内聚性
7
是否存在重复代码且它的功能可以通过调用其他方法实现
8
方法参数数量是否控制在5个以内
性能/算法缺陷
1
是否存在更好的数据结构和算法可以采用
铁路货物运输品名分类与代码表
附件一铁路货物运输品名分类与代码表“铁路货物运输品名分类与代码表”、《铁路货物运输品名检查表》编制使用说明一、编制说明(一)编制原则1．以GB7635—87国家标准《全国工农业产品(商品、物资)分类与代码》为基础标准，参照国家统计局颁布的《货物运输量分类目录》，遵循国家分类标准的基本原则，结合铁路运输生产经营的特点和行业管理的需要。
2．以货物的自然属性、生产特征为主要分类标志，个别按用途归类。
同时考虑货物的国民经济意义、运量大小、运送条件和运价的要求。
3．适当照顾当前管理水平，兼顾历史资料的衔接与可比性以及运价现状和改革的需要，并留有扩展余地。
4．与国家标准和相关标准兼容。
(二)结构与编码“铁路货物运输品名分类与代码表”(以下简称分类与代码表)横向结构由代码、货物品类、运价号和说明四部分组成。
《铁路货物运输品名检查表》(以下简称检查表)横向结构由代码、拼音码、品名、整车运价号、零担运价号五部分组成。
货物品类分大类、中类、小类和细目四个层次。
大类、中类为运价、运输统计、计划、财务等使用的统一的货物品类名称。
小类是判定运价号、建设基金号和保价费率号的依据。
细目即品名，由部统一颁发，并以货物运输品名检查表形式对外公布。
其中大、中、小类在分类与代码表中列示，细目在检查表中列示。
代码采用7位数字码，相应分四个层次，由高位到低位，第一、二两位为大类码，第三位为中类码，第四位为小类码，第五、六、七位为品名码。
分类与代码表中只列示前四位。
在第一、二、三层次一般都设有收容类目，大类收容类目为“其他货物”用代码99表示，中、小类的收容类目“其他××”用末位为9的代码表示。
如果下一层次的类目不再细分时，在其代码后面补0。
各层次均留有适当空码，以备补充、调整。
同一小类内品名按品名的汉语拼音字头顺序编码。
“说明”栏是对各该品类的内容、特征、相互交叉事项和计费规定的必要提示和解释。
(三)货物名称与拼音码1．列入检查表的货物名称即细目，也称品名，采用通用、标准名称，包括具体名称和概括名称，除明定者外，一般不分形态、品种、商标、产地、规格、型号、用途、新与旧、完好与废次、天然与人造。
软件项目代码检查表
66
印。应该将异常记入日志或者包装后向上层抛出。对于 表现层页面，不应该出现程序异常，应该在捕获到异常
强制
后进行友好的提示。
67
对于静态方法，应该使用类名去使用，不应该用实例去 引用，主要是为了体现更多的语义。
强制
68
对一些基本数据类型和不太可能通过继承进行扩展的 类，应声明为readonly，提高效率。
强制
3
书写规范
修改源代码时，应尽量保持与所修改系统的编码风格保 持一致。
强制
4
命名规范 所有命名空间名称必须使用ESSE前缀。
强制
5
应该使用VS2005默认格式规范。
强制
6
一个C#源文件.cs应该只包含一个类，内嵌类和匿名类除 外。把所有枚举变量集中定义到同一个源文件中。
强制
7
命名空间的引用应该按照相关性进行分组。
28
进行外部访问。如果成员函数仅为自己和派生类使用， 强制
使用protected，如果仅仅为类本身访问，使用private。
29
命Байду номын сангаас空间应该使用Pascal命名方式，不要出现下划线等 符号，名词用有意义的缩写或者英文单词。
强制
30
所有类命名使用Pascal表示方式，使用名词组合。
强制
31
接口命名使用字母 “I” 加上 Pascal 形式的表示方式。
强制
15
循环变量应靠近循环体初始化。
强制
版本号：2 修订号：0
C#代码规范 缺陷描述
第1页 共6页
16
避免长的布尔表达式，应该换成多个更容易理解的表达 式。
强制
17
代码缩进，应该使用4个空格为一个单位进行缩进。
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
代码检查表
# 通用版面风格 1 2 3 编写格式是否一致？ 是否有可读性并易于维护？ 文件是否过长？ 检查项
ቤተ መጻሕፍቲ ባይዱ
通用代码编写规范 1 2 3 4 5 6 文件、变量以及方法命名是否统一且有意义？ 是否用定义的常量代替实际的数据或字符串？ 是否存在没有使用到的变量、代码或文件？ 逻辑控制是否正确、简洁？ 是否对异常进行了处理？ 对外接口的输入输出参数是否进行了校验、记录？
通用注释规范 1 2 3 4 注释是否清晰、简洁，有助于他人对代码的理解？ 注释是否解释了代码的目的，或总结了代码所要完成的工作？ 注释是否与代码同步？ 是否描述了文件目的、作者与修改记录？
是/否/不适用
是 是 是
是 是 否 是 是 是
否 是 是 是
# 通用版面风格 1 2 3 编写格式是否一致？ 是否有可读性并易于维护？ 文件是否过长？ 检查项
ቤተ መጻሕፍቲ ባይዱ
通用代码编写规范 1 2 3 4 5 6 文件、变量以及方法命名是否统一且有意义？ 是否用定义的常量代替实际的数据或字符串？ 是否存在没有使用到的变量、代码或文件？ 逻辑控制是否正确、简洁？ 是否对异常进行了处理？ 对外接口的输入输出参数是否进行了校验、记录？
通用注释规范 1 2 3 4 注释是否清晰、简洁，有助于他人对代码的理解？ 注释是否解释了代码的目的，或总结了代码所要完成的工作？ 注释是否与代码同步？ 是否描述了文件目的、作者与修改记录？
是/否/不适用
是 是 是
是 是 否 是 是 是
否 是 是 是