代码审查技术-烽火PPT课件

/*******************************************************

**计算3个三角形的周长，打印出最大周长和最小周长，

和每个三角形的类型（普通，非法，等腰，等边**

*******************************************************/

1) #include

2) #include

3) #include /*缺少了math.h*/

4) #define NORMAL 1 /*普通三角形*/

5) #define INVALIDATE 2 /*非法三角形*/

6) #define ISOSCELES 3 /*等腰三角形*/

7) #define EQUILATERAL 4 /*等边三角形*/

8) typedef struct tagTriangle /*属于公共耦合，建议改成更低级

耦合。如无直接耦合、数据耦合、标记耦合、控制

耦合、外部耦合。可能改成标记耦合。*/

9) {

10) char name[10];

11) int x; /*边长*/

12) int y; /*边长*/

13) int z; /*边长*/

14) short girth; /*周长*/

15) int type;/*类型*/

16) }Triangle;

17) #define min(a, b) ((a < b) ? a : b) /*宏定义函数*/ /*错误，宏单数应该用括号围起来。举例#define s(x) x*x ，执

行 s(1+2)结果为5 ，而不是9*/

18) #define max(a, b) ((a > b) ? a : b) /*宏定义函数*/ /*错误，

宏单数应该用括号围起来*/

19) void calculate(Triangle* pTriangle) /*判断三角形的类型*/

20) {

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

在软件开发过程中，代码审查是一项至关重要的活动。它不仅可以帮助开发人员发现代码缺陷，还可以提高代码质量，降低维护成本。本文将探讨软件开发流程中的代码审查。

1. 什么是代码审查？

代码审查是一种通过人工检查代码的方法，以检测错误、提高质量和确保符合标准的过程。通常，代码审查由一个团队来执行，其中包括开发人员和其他技术成员。团队成员将代码分析为对应的功能，并根据项目的需求进行评估。

2. 代码审查的目的

代码审查的目的是发现和修复代码缺陷，提高代码的可读性、可维护性和可靠性。通过审查，可以发现代码中的各种错误，如语法错误、逻辑错误、性能问题、安全漏洞等。除了发现错误之外，审查还可以提供有关代码的反馈，如改进组织和清晰度，以便于开发人员进行更好的编写和管理。

3. 代码审查的类型

代码审查分为两种类型：静态代码审查和动态代码审查。

静态代码审查是一种使用自动化工具或人工检查代码，以发现软件开发期间隐藏的错误或不良实践的过程。使用静态代码分析工具可以帮助检测一些比较常见的错误，如空指针引用、内存泄漏和死循环等。

动态代码审查则主要是在程序运行时检查代码缺陷。动态代码审查可以更深入地了解代码的行为，以便更好地发现漏洞。虽然动态代码审查可以提供更准确的结果和建议，但是它需要更多的时间和精力来完成。

4. 代码审查的步骤

代码审查通常包括以下步骤：

步骤1：准备

在进行代码审查之前，需要做好准备工作。首先，需要为代码审查指定一个负责人或团队成员来领导和组织代码审查的所有过程。其次，负责人需要为团队成员提供审查计划、要求和准则文件，以确保审查得以有效进行。最后，准备好审查软件或工具，以便团队成员能够更快地定位代码中的问题。

步骤2：预审

在进行正式的代码审查之前，进行预审是非常必要的。对于一个大项目，预审能够节省很多时间和精力。在预审阶段，各成员可以自主对代码进行查看和简单分析。如果在预审阶段就发现了问题，会更容易及时修复。如果没有找到问题，则可以进行下一步操作。

第3章代码检查、⾛查与评审

代码检查与⾛查

代码检查、⾛查以及可⽤性测试是三种主要的⼈⼯测试⽅法。⼈⼯测试技术在查找错误⽅⾯⾮常有效，应该在程序开始编码之后、基于计算机的测试开始之前使⽤这些⽅法。本章主要介绍的是代码检查与⾛查的相似之处，⽽它们的不同之处将在后续章节中介绍。

代码检查与⾛查都要求⼈们组成⼀个⼩组(⼀场"头脑风暴会")来阅读或直观检查特定的程序。

"头脑风暴会"的⽬标是找出错误来，但不必找出改正错误的⽅法。在代码⾛查中，⼀组开发⼈员(三到四⼈为最佳)对代码进⾏审核。其中只有⼀⼈是代码的作者。因此，代码⾛查的主要⼯作是由其他⼈，⽽不是作者本⼈完成的，这和软件测试的第 原则，也即"软件编写者往往不能有效地测试⾃⼰的软件"相符合。

代码检查与⾛查是对过去桌⾯检查过程(在提交测试前由程序员阅读⾃⼰程序的过程)的改进。因为在实施过程中，除了软件编写者本⼈，还有其他⼈参与进来。代码⾛查的另⼀个优点在于，⼀旦发现错误，通常就能在代码中对其进⾏精确定位，这就降低了调试(错误修正)的成本。在典型的程序中，这些⽅陆通常会有效地查找出30%-70%(这些⽅陆在测试过程结束时可以有效地查找出多达70%的已知错误)的逻辑设计和编码错误。这些⽅法不能有效地查找出⾼层次的设计失误，例如在软件需求分析阶段的错误。代码检查/⾛查与基于计算机的测试是互补的。缺少其中任何⼀种，错误检查的效率都会降低。

代码检查

所谓代码检查，是以组为单位阅读代码，它是⼀系列规程和错误检查技术的集合。

代码检查⼩组

⼀个代码检查⼩组通常由四⼈组成：协调⼈员，代码作者，程序设计⼈员(不同于编码者)，测试专家

协调⼈负责确保检查会议的讨论⾼效地进⾏、每个参与者都将注意⼒集中于查找错误⽽不是修正错误(错误的修正由程序员在检查会议之后完成)。测试专家应该具备较⾼的软件测试造诣井熟悉⼤部分的常见编码错误。

检查议程与注意事项

在进⾏代码检查时，主要进⾏下列两项活动：

由程序编码⼈员逐条语句讲述程序的逻辑结构参考常见的编码错误列表分析程序

软件工程中的代码审查方法与注意事项

引言

代码审查是软件工程中至关重要的环节之一。它可以帮助发现潜在的问题和缺陷，提高代码质量，减少后期维护成本。本文将从不同角度探讨代码审查，包括审查方法、注意事项以及其在软件开发中的重要性。

1. 代码审查方法

静态代码审查

静态代码审查是通过静态分析工具检查代码，发现一些潜在的问题。常见的静态分析工具包括PMD、FindBugs和Checkstyle等。它们可以检查代码风格、空指针引用、资源泄漏等问题。静态代码审查能够帮助开发人员在编码阶段及时发现问题，并提供相应的修改建议。

邮件审查

邮件审查是一种异步的代码审查方法。开发人员将自己的代码发送给团队中的其他成员，其他成员通过邮件的形式进行审查。邮件审查的好处是可以灵活安排时间，提供详细的意见和建议。然而，邮件审查也存在着可能导致审查变慢的问题，因为需要等待每个人的回复。因此，在进行邮件审查时，及时回复和交流是非常重要的。

会议审查 会议审查是一种同步的代码审查方法。开发人员将自己的代码在会议上展示，其他与会人员进行实时的批评和讨论。会议审查的好处是能够及时解决问题，加快开发进程。然而，会议审查也需要统筹安排时间和参与人员，否则可能浪费大量的时间。因此，在进行会议审查时，合理安排时间和提前准备是非常重要的。

2. 注意事项

坚持规范

代码审查的一个重要目的是保证代码质量和一致性。因此，在进行代码审查时，应该坚持遵守规范和约定。代码审查人员应该对相关的规范和约定进行了解，并在审查过程中对不符合规范的地方提出建议。

注重可读性

可读性是代码质量的一个重要指标。好的代码应该具有良好的可读性，便于他人理解和维护。在进行代码审查时，应该特别注重代码的命名规范、注释的完整性和逻辑的清晰性。

关注边界条件

边界条件是容易导致问题的地方。在进行代码审查时，应该特别关注边界条件的处理。例如，检查循环的起始和终止条件是否正确、处理非法输入等。边界条件的处理是保证代码正确性的关键。