代码审查流程与要点PPT.ppt

copyright,2005leador,单击此处编辑母版标题样式,单击此处编辑母版文本样式,第二级,第三级,第四级,第五级,2,*,Control We Believe in,代码审查流程与要点,生产平台组,2016-1-23,立得空间信息技术股份有限公司,1,2025/4/30 周三,目录,1.,概述,2.,代码审查的目的,3.,代码审查的好处,4.,代码审查的局限性,5.,代码审查内容,6.,代码审查流程,7.,代码审查工具,2,2025/4/30 周三,1.,概述,Code,Review,代码审查是指软件开发过程中，通过对源代码进行系统性检查的过程。通常的目的是查找各种缺陷，包括代码缺陷、功能实现问题、编码合理性、性能优化等；保证软件总体质量和提高开发者自身水平。,3,2025/4/30 周三,2.,代码审查的目的,检查,开发人员,是否遵守开发规范中的规定,检查代码是否存在审定,表中的错误,检查代码是否存在逻辑,错误、性能低下或安全问题,4,2025/4/30 周三,3.,代码审查的好处,提高,代码质量,及早,发现潜在缺陷，降低修改,/,弥补缺陷的成本,促进,团队内部知识共享，提高团队的整体水平,评审,过程对于评审人员来说，也是一种思路重构的过程，帮助更多的人理解系统,是,一种传递知识的手段，可以让其它并不熟悉代码的人知道作者的意图和想法，从而可以在以后轻松维护代码,鼓励,程序员们相互学习对方的长处和有点,可以,被用来确认设计和实现是否合理，检查设计是否清楚和简单,5,2025/4/30 周三,4.,代码审查的局限,无法,完全验证逻辑是否正确，无法检查功能是否完整；,无法,检测代码中遗漏的路径和数据敏感性错误,不,验证规格的正确性,代价高昂，对于,以上局限，需要编写正确的详尽的测试用例，进行功能测试和集成测试来弥补。,6,2025/4/30 周三,5.,审查内容,基本规范：检查代码编写是否满足编码规范；,程序逻辑：检查基本的程序逻辑、性能、安全性等是否存在问题，用户交互流程是否满足正常的软件使用要求；,软件设计：检查软件的基础设计、模块之间的耦合关系、第三方库或框架的使用是否合理。,代码审查分,3,个等级：,7,2025/4/30 周三,5.1,基本规范,项目在立项时需确定本项目所遵循的编码规范，如有特殊要求，可在通用编码规范基础上进行适当修改。纯,C+/VC+,开发项目应遵守,C+,编码规范,，,C#,开发项目应遵守,C#,编码规范,，混合开发项目应遵守两种编码规范。,8,2025/4/30 周三,5.1,基本规范：案例,1,成员变量命名不规范；,成员变量访问权限申明方式不一致；,代码之间的空行不符合规范；,部分成员变量只有申明，没有初始化；,没有注释,9,2025/4/30 周三,5.1,基本规范：案例,2,一个代码文件中包含多个类；,一个代码文件中代码过长；,有的类中成员变量有初始值，有的没有；,有的类有注释，有的没有。,10,2025/4/30 周三,5.2,程序逻辑,程序逻辑检查软件基本的程序逻辑是否合理，包括循环、递归、线程、事务等代码结构上的合理性。还包括异常处理、性能、重复代码、可优化代码，无效代码等的检查。在代码程度上检查用户界面操作逻辑是否正确、布局是否合理、用户提示是否简捷明了、是否存在重复或无用功能等。,11,2025/4/30 周三,5.2,程序逻辑：案例,1,异常淹没：异常捕获后没有进行任何处理，也没有将异常抛出。,12,2025/4/30 周三,5.2,程序逻辑：案例,2,提示框不符合要求：没有标题，没有显示图标（提示、警告、借误等）。,提示表意不清，应明确显示是什么结点没有选中，而且结点是程序语言，要翻译成用户语言，如：未选中兵要，请先选择一个兵要！。,13,2025/4/30 周三,5.3,软件设计,软件设计检查软件的层次结构划分是否合理，,UI,层、逻辑层、数据层、组件层等是否清晰，有无混淆；软件在性能设计、安全性设计、易维护性设计、健壮性设计等设计方面是否合理。,14,2025/4/30 周三,5.3,软件设计：案例,1,工程命名有问题：该项目没有引入插件框架，这个工程是从其他项目拷贝而来，但是工程名称没有修改正确；,都是,ArcGIS,工具类，但是分散在,2,个工程中，应该把第,2,个工程中的工具类移到第,1,个工程中。,15,2025/4/30 周三,6.,代码审查流程,立项阶段,编写代码审查计划书,建立代码审查缺陷库,确定编码规范,研制阶段,提交代码审查申请单,代码审查入口检查,实施代码审查,输出代码审查报告,存在缺陷,是,代码整改,否,归档,结项阶段,编写代码审查总结报告,存档,16,2025/4/30 周三,6.1,立项阶段,编写代码审查计划书：,描述项目或产品在研制过程中进行代码审查活动的时间与周期，明确项目开发负责人、代码审查负责人；,建立代码审查缺陷库：在项目或产品研制开始前开发负责人按照部门代码审查缺陷库模板,建立代码审查缺陷,库，建立所有开发人员和审查人员的权限；,确定编码规范：开发负责人确定本项目或产品研制需遵循的编码规范，并上传至代码审查缺陷库中。,17,2025/4/30 周三,6.2,研制阶段,提交代码审查申请单：到达项目,/,产品代码审查时间节点时，开发负责人确定代码基线，提交代码审查申请单给代码审查负责人；,代码审查入品检查：代码审查负责人检查代码库中的代码基线是否满足代码审查条件，如不满足，退回至开发负责人；,实施代码审查：审查负责人分配代码审查任务给审查人员，审查人员利用工具或手动按照编码规范与经验对代码进行审查。,18,2025/4/30 周三,6.2,研制阶段,输出代码审查报告：代码审查完成后，审查负责人编写代码审查报告至开发负责人；,代码整改：,代码审查报告,中如果存在不符合项，开发负责人按照不符合项分配代码整改任务；整改完成后重复,15,过程。,19,2025/4/30 周三,6.3,结项阶段,项目结项时，代码审查负责人编写,代码审查总结报告,并向部门作总结报告，帮助部门整理该项目研制过程中出现的代码质量问题，其他项目组应以此为鉴，杜绝出现类似问题。,20,2025/4/30 周三,7.,代码审查工具,1.SourceAnalysis,（,StyleCop,）：代码自动化检查工具，检查代码是否按照制定的编辑规则进行编码，可与,Visual Studio,集成。,21,2025/4/30 周三,谢谢！,22,2025/4/30 周三,