软件开发中的代码审查流程

龙源期刊网

代码审查在软件工程实施中的重要性

作者：井涛

来源：《电子技术与软件工程》2017年第21期

摘 要软件工程的实施，使得软件质量有了明显的提升，在取得成效之余，不应忽视代码审查的重要作用，本文阐述了代码审查的不可替代性并给出了软件工程实施过程中的具体做法。

【关键词】软件工程 CMMI 代码审查 质量监控 每千行代码发现缺陷数

1 引言

随着CMMI认证获得普遍认可，软件工程在保证软件质量、提高软件效率方面取得了瞩目的成效，实施软件工程已经是大多数公司的共识。随着软件工程的实施，软件的质量监控手段呈现多样化，不再单纯依赖软件测试，只是在软件质量取得显著可见成效的欣喜中，软件测试的地位有弱化的倾向，带来的问题是，软件代码审查作为有效的软件质量提升手段，在软件工程实施中有日渐弱化并有可能消失。

软件代码审查是软件测试的手段之一，是在执行动态测试之前对代码的人工走读排错活动，主要方法包括个人代码审查、项目内交叉代码互审、正式代码审查。个人代码审查在编码过程中随时开展，项目内交叉代码互审也是在编码过程中，一般每周开展，正式代码审查是在前两种代码审查的基础上，可以在编码和单元测试期间的任意时间开始。本文所讲的代码审查是指正式代码审查，该审查需召集同行专家采用会议形式对代码进行集中评审，集思广益审查代码的缺陷，是一种高效的发现代码缺陷的方式。

2 软件工程化过程中的软件质量监控手段

软件工程化过程的典型模型如图1所示。

如图1所示，项目的研发过程中通常采用U模型或者V模型，将软件研发过程划分为不同的阶段，每一个阶段的工作产品有对应的测试活动保证质量。软件工程实施时，除了通过传统的测试活动保证质量之外，还要在每个阶段末进行质量审查，以保证工作的有效性。这样的质量监控手段比单纯的依靠测试活动，软件质量的提升是显而易见的。

软件设计开发　计算机光盘软件与应用　Ｃｏｍｐｕｔｅｒ　ＣＤ　Ｓｏｆｔｗａｒｅ　ａｎｄ　Ａｐｐｌ　ｉｃａｔ　ｉｏｎｓ　２０１２年第３期　浅谈软件静态测试中的代码审查　袁政江　（江南机电设计研究所，贵阳５５０００９）　摘要：本文描述了软件代码审查的作用、代码审查内容、代码审查过程，并列举一些常见代码审查问题。　关键词：软件代码审查；代码审查过程；代码审查问题　中图分类号：ＴＰ３１１．５２　文献标识码：Ａ　文章嫡号：１００７—９５９９（２０１２）０３－０２０２－０２　Ｄｉｓｃｕｓｓｉｏｎ　ｏｎ　ｔｈｅ　Ｃｏｄｅ　Ｒｅｖｉｅｗ　ｏｆ　Ｓｏｆｔｗａｒｅ　Ｓｔａｔｉｃ　Ｔｅｓｔｉｎｇ　Ｙｕａｎ　Ｚｈｅｎ￣ｉａｎｇ　（Ｊｉａｎｇｎａｎ　Ｉｎｓｔｉｔｕｔｅ　ｏｆ　Ｅｌｅｃｔｒｉｃａｌ　ａｎｄ　Ｍｅｃｈａｎｉｃａｌ　Ｄｅｓｉｇｎ，Ｇｕｉｙａｎｇ　５５０００９，Ｃｈｉｎａ）　Ａｂｓｔｒａｃｔ：Ｔｈｉｓ　ｐａｐｅｒ　ｄｅｓｃｒｉｂｅｓ　ｔｈｅ　ｓｏｆｔｗａｒｅ　ｃｏｄｅ　ｔｏ　ｅｘａｍｉｎｅ　ｔｈｅ　ｒｏｌｅ，ｃｏｎｔｅｎｔ，ｃｏｄｅ　ｒｅｖｉｅｗ　ｐｒｏｃｅｓｓ，ａｎｄ　ｌｉｓｔｓ　ｓｏｍｅ　ｃｏｍｍｏｎ　ｐｒｏｂｌｅｍｓ　ｏｆ　ｃｏｄｅ　ｒｅｖｉｅｗ．　Ｋｅｙｗｏｒｄｓ：Ｓｏｆｔｗａｒｅ　ｃｏｄｅ　ｒｅｖｉｅｗ；Ｃｏｄｅ　ｒｅｖｉｅｗ　ｐｒｏｃｅｓｓ；Ｃｏｄｅ　ｒｅｖｉｅｗ　ｐｒｏｂｌｅｍ　一、引言　软件测试常用方法可分为动态测试和静态测试，只有动态测　试和静态测试有效结合，才能更好的完成软件测试工作。代码审　查是软件静态测试中常用的软件测试方法之一，代码审查时，只　要测试人员方法得当、足够细心，往往能够产生意想不到的效果。　二、代码审查的作用　代码审查是在不执行软件的条件下有条理的仔细审查软件代　码，从而找出软件缺陷的过程。　代码审查可以找出动态测试难以发现或隔离的软件缺陷。在　开发过程初期让测试人员集中精力进行软件代码审查非常有价　值：可以提高代码质量；在项目的早期发现缺陷，将损失降至最　低；促进团队沟通、促进知识共享、共同提高。　代码审查还可以为动态测试时设计和执行测试用例提供思　路。通过代码审查，可以确定有问题或者容易产生软件缺陷的特　性范围。　三、代码审查的过程　——头文件中是否存在可执行的代码？　——定义为指针的变量是否作为指针使用（而不是作为整　数）？　指针是否初始化？　——释放内存后是否将指针立即设置为ＮＵＬＬ（或Ｏ）？　——传递指针到另一个函数的代码是否首先检查了指针的有　效性？　——通过指针写入动态分配内存的代码是否首先检查了指针　的有效性？　——宏的命名是否都大写？　——数组是否越界？　（４）接口：　在所有的函数及过程调用中，参数的个数都正确吗？　——形参与实参类型匹配吗？　——参数顺序正确吗？　一一如果访问共享内存，是否具有相同的共享内存结构模　代码审查过程可分为：代码审查策划阶段、代码审查实施阶　式？　段以及代码审查总结阶段。　（一）代码审查策划阶段　１．项目负责人分配代码审查任务；　２．确定代码审查策略：依据软件开发文档，确定软件关键模　块，作为代码审查重点；将复杂度高的模块也作为代码审查的重　点；　３．项目负责人确定代码审查单，审查内容一般可包括：　（１）可追溯性：　代码是否遵循详细设计？　——代码是否与需求一致？　（２）逻辑：　——表示优先级的括号用法是否正确？　——代码是否依赖赋值顺序？　——“ｉｆ…ｅｌｓｅ”和“ｓｗｉｔｃｈ”使用是否正确清晰？　——循环能否结束？　——复合语句是否正确地被花括号括起来？　——ｃａｓｅ语句是否所有可能出现的情况均已考虑？　——“ｇｏｔｏ”是否使用？　（３）数据：　——变量在使用前是否已初始化？　——变量的声明是否按组划分为外部的和内部的？　——除最明显的声明外，是否所有声明都有注释？　——每个命名是否仅用于一个用途？　——常量名是否都大写？　——常量是否都是通过“＃ｄｅｆｉｎｅ”定义的？　——用于多个文件中的常量是否在一个头文件中定义？　（５）文档：　——软件文档是否与代码一致？　（６）注释：　——注释与代码是否一致？　——用于理解代码的注释是否提供了必要的信息？　——是否对数组和变量的作用进行了描述？　（７）异常处理：　——是否所有可能的错误都已加以考虑？　（８）内存：　——在向动态分配的内存写入之前是否检查了内存申请是否　成功？　——若采用动态分配内存，内存空间分配是否正确？　——当内存空间不再需要时，是否被明确的释放？　（９）其它：　——是否检查了函数调用返回值？　所有的输入变量都用到了吗？　——所有的输出变量在输出前都已赋值了吗？　４．确定代码审查进度安排，项目负责人负责安排代码审查的　进度。　（二）代码审查实施阶段　１．代码讲解：软件开发人员详细向测试人员讲解如何以及为　何这样实现，测试人员提出问题和建议。通过代码讲解，测试人　员对被审查的软件有了一个全面的认识，为后续代码审查打下良　好的基础。　２．静态分析：一般采用静态分析工具进行，主要分析软件的　（下转第２０４页）　—・——２０２－－

软件测试类型及其在软件开发过程中的地位、代码检查、走查与评审

(总分99,考试时间90分钟)

选择题

1. 把经过评审通过的各项需求转换为一个相应的体系结构，包括数据的体系结构、系统和软件的体系结构，这是软件生命周期哪一阶段做的事情______。A.系统和需求定义 B.编程和单元测试 C.软件设计 D.运行和维护

2. 之所以要对已交付使用的软件进行维护，原因是______。

Ⅰ．为了增强软件的功能，满足功能上的变更

Ⅱ．运行中发现了软件中的错误需要更正

Ⅲ．为了适应软件工作环境变化而引起的相应改变A.Ⅰ B.Ⅰ和Ⅲ C.Ⅱ和Ⅲ D.Ⅰ和Ⅱ和Ⅲ

3. 以下不属于软件需求分析阶段测试的内容是______。A.通过场景走查和与用户沟通，看需求是否是用户“真”的需求 B.通过对开发进度、开发费用、产品性能、可靠性和内存使用等各方面需求的分析，看综合起来是否合理，是否有对需求的一个优先级安排 C.通过领域分析和与用户沟通，看需求是否是完备的 D.通过检查需求与实现环境的不相容之处，看需求是否可兼容

4. 下列可以做为软件测试对象的是______。A.需求规格说明 B.软件设计规格说明 C.源程序 D.以上全部

5. MM-路径集成是一种基于消息的路径集成方法，其中MM-路径是指______。A.对应调用图的每一个边建立并执行的一个集成测试会话序列 B.针对模块的每一个程序剖面执行的语句序列 C.按照广度优先策略逐层集成与测试的序列 D.穿插出现在各模块中执行的方法和消息的序列

6. 测试过程需要输入软件配置、测试配置和测试工具。其中不属于测试配置的是______。A.测试计划 B.测试用例 C.测试报告 D.测试程序

7. 面向对象的软件设计要首先考虑问题中的数据实体，通过实体提供的服务和实体之间的消息的传递来实现某种计算，这种体系结构的好处体系在______。A.稳定性 B.一致性 C.可靠性 D.效率

代码审查流程

代码审查是软件开发过程中至关重要的环节，它可以帮助开发团队发现和修复潜在的代码缺陷，提高代码质量和可维护性。在本文中，我们将介绍一个典型的代码审查流程，以帮助团队成员更好地理解和遵循相应的规范。

一、代码审查的目的和重要性

代码审查的目的是确保开发团队编写的代码符合预先设定的标准和规范，以便降低软件开发过程中的错误率，并提高软件的可维护性和可读性。代码审查可以发现潜在的逻辑错误、性能问题和安全漏洞，并及时进行修复，从而减少后期维护工作的成本。此外，代码审查还可以促进团队成员之间的知识分享和经验积累，提高整个团队的技术水平。

二、代码审查的基本步骤

1. 预审查准备

在进行代码审查之前，需要做好预审查准备工作。首先，指定一位经验丰富的开发人员或团队负责人作为审查人员，确保审查人员具备足够的专业技术和领域知识。其次，为待审查的代码分配一个时间段，确保审查人员有足够的时间仔细审查每一行代码。最后，确保审查人员能够访问到待审查的代码，通常使用版本控制系统来管理代码库。

2. 代码审查过程 代码审查的过程可以分为以下几个步骤：

(1) 审查准备：审查人员需要详细阅读待审查的代码，并了解代码的背景和功能。此外，审查人员还需要熟悉代码的编写规范和标准，以便能够准确评估代码的质量。

(2) 问题发现：审查人员需要结合代码编写规范和标准，仔细检查代码中可能存在的潜在问题。这些问题包括但不限于：命名不规范、缺少注释、重复代码、逻辑错误、资源泄漏等等。审查人员应该尽可能多地提出问题，并标记在代码中，以便开发人员能够快速定位和解决。

(3) 问题讨论：开发人员在收到审查人员提出的问题后，需要与审查人员进行讨论，明确问题的原因和解决方案。这个过程是开发人员和审查人员之间的交流和协作，可以加深彼此的理解，提高代码质量。

(4) 问题修复：开发人员根据审查人员提出的问题，对代码进行相应的修改和优化。修复后的代码需要重新提交给审查人员进行二次审查，确保问题得到解决。