1 / 10
文档名称:

代码审查规范样稿.docx

格式:docx   大小:59KB   页数:10页
下载后只包含 1 个 DOCX 格式的文档,没有任何的图纸或源代码,查看文件列表

如果您已付费下载过本站文档,您可以点这里二次下载

分享

预览

代码审查规范样稿.docx

上传人:书犹药也 2020/11/16 文件大小:59 KB

下载得到文件列表

代码审查规范样稿.docx

相关文档

文档介绍

文档介绍:代码审查规范
1. Code Review目标
Code Review是一个用来确定方案设计和代码实现质量确保机制,经过这个机制我们能够对 代码、测试过程 和 注释 进行检验。
Code Review关键用来在软件工程过程中改善代码质量,经过Code Review能够达成以下目标:
在项目早期就能够发现代码中BUG。
帮助初级开发人员学****高级开发人员经验,达成知识共享。
避免开发人员犯部分很常见,很一般错误。
确保项目组人员良好沟通。
项目或产品代码更轻易维护。
 
2. Code Review前提条件
代码提交审核前,开发者 必需确保代码符合以下条件,审核者 需要确保全部前提条件全部已满足方可开始审查,同时也是审查关键检验点。
全部代码注释清楚,语法正确,编译经过。
日志代码完整,业务日志、系统日志分开,汉字描述,脱敏处理,状态变更,全部清楚明确。
测试代码覆盖全部分支和步骤,临时统一使用工具Emma(各编译器可下载对应插件)进行Coverage Check。
项目引用关系明确,依靠关系清楚,配置文件描述。
 
3. Code Review审查范围
代码一致性、编码风格、代码安全问题、脱敏问题、代码冗余、是否正确设计以符合设计要求(性能、功效)和设计文档相相同等。
、 完整性检验(Completeness)
代码是否完全实现了设计文档中所包含全部步骤和功效点
代码是否已包含全部所需业务日志、系统日志、异常日志,日志内容是否完整,日志文件配置是否正确。
代码是否使用缓存等,配置信息是否正确可配置。
代码中是否存在任何没有定义或没有引用到变量、常数或数据类型等
、 一致性检验(Consistency)
代码逻辑是否符合设计文档
代码中使用格式、符号、结构等风格是否保持一致
、 正确性检验(Correctness)
代码是否符合制订标准
全部变量全部被正确定义和使用
全部注释全部是正确
全部程序调用全部使用了正确参数个数
、 可修改性检验(Modifiability)
代码包含到常量是否易于修改(如使用配置、定义为类常量、使用专门常量类等)
代码中是否包含了交叉说明或数据字典,以描述程序是怎样对变量和常量进行访问
代码是否只有一个出口和一个入口(严重异常处理除外)
、 可估计性检验(Predictability)
代码所用开发语言是否含有定义良好语法和语义
是否代码避免了依靠于开发语言缺省提供功效
代码是否无意中陷入了死循环
代码是否避免了无穷递归
、 健壮性检验(Robustness)
代码是否采取方法避免运行时错误(如数组边界溢出、被零除、值越界、堆栈溢出等)
、 结构性检验(Structuredness)
程序每个功效是否全部作为一个可辩识代码块存在
循环是否只有一个入口
、 可追溯性检验(Traceability)
代码是否对每个程序进行了唯一标识
是否有一个交叉引用框架能够用来在代码和开发文档之间相互对应
代码是否包含一个修订历史统计,统计中对代码修改和原因全部有统计
是否全部安全功效全部有标识
、 可了解性检验(Understandability)
注释是否足够清楚描述每个子