3.3 LOGISCOPE使用指导书

LogiScope中的代码质量分析工具

关键词：测试工具、代码质量、软件可维护性

摘 要：LogiScope主要提供静态结构分析、代码质量分析和动态覆盖率分析三大功能，本文是代码质量分析部分的入门介绍。

一、前言

ISO/IEC 9126国际标准（参见NF ISO/CEI 9126中的AFNOR）所定义的软件质量包括以下六个方面：

-- 功能性（FUNCTIONALITY）

-- 可靠性（RELIABILITY）

-- 可用性（USABILITY）

-- 有效性（EFFICIENCY）

-- 可维护性（MAINTAINABILITY）

-- 轻便性（PORTABILITY）

LOGISCOPE质量模型用来评估一个程序的的可维护性（MAINTAINABILITY），它符合ISO标准。使用LOGISCOPE工具WinDoc可以自动生成代码质量分析报告，在报告中，可维护性采用以下四个分类标准来评估：

-- 可分析性（ANALYZABILITY）

-- 可修改性（CHANGEABILITY）

-- 稳定性（STABILITY）

-- 可测性（TESTABILITY）

依据这些标准和最终报告，将代码的质量分成四个等级：

☆ 优秀（EXCELLENT） ：符合本模型框架中的所有规则。

☆ 良好（GOOD） ：未大量偏离模型框架中的规则。

☆ 一般（FAIR） ：违背了模型框架中的大量规则

☆ 较差（POOR） ：无法保障正常的软件可维护性

依据LOGISCOPE质量模型，前三者被认为可以接受的，最后一个等级则是不可接受的。下面将详细介绍LOGISCOPE质量模型的原理与应用。

二、质量建模

1）质量建模原理

为评估软件质量，首先要实现代码的模块化，模块化标准可遵循Boehm [BOEHM,75]和McCall [MCCALL,77]的定义。

可用一系列特性描述软件质量：

--用户所关心的质量因素

--由开发者决定的质量标准

--用于度量与验证目的的质量规则

我们按照下面步骤建立质量模型：

(a)把质量因素用术语（功能性、可靠性、可用性、可维护性等）表述

如：可维护性是质量因素中的一个重要指标，我们第一个目的是：

（a better）possibility of detecting, locating and correnting anomalies, of introducing minor changes and then of accomplishing the required functions with the anticipated resources.

[GAM -- T17(V2) July 1989]

(a)对该术语设计分类质量标准

如：对可维护性分类设计质量标准为：自描述性、简单性、可读性...

其中对自描述性的定义如下：

(...)attributes of the software that provide explanation of the implementation of a function [Ref. McCALL , 77]

(a)设定编程规则,对各个分类质量标准设定相关的行为规范

(b)建立度量规则，对行为规范进行量化

如：为自描述性的目标，以多种指标对自描述性进行量化：注释总数、注释频度...等，其中注释频度规定为：

the source code must contain at least 1 comment for 5 executable staements and 1 coment at the most for 1 statement.

这样，注释频度在0.2--1之间才被认为是合理的，否则需改进。象这种规定，我们叫度规（metrics）。

如此，我们可以在三个层次组织软件的质量模型，如图1所示：

图1. 质量模型的三个层次

2）LogiScope中的质量模型

LogiScope所定义质量模型（在文件isoccpp.ref中定义）可分为两大部分：

函数级：对每个函数的代码质量进行评估

系统级：对应用程序的代码质量进行评估

LogiScope在度规层次（metrics level）、分类标准层次（criteria level）和质量因素层次（quality factor level）提供对代码质量的分析，下面分别描述这三个层次：

a)度规层次

在这一层次针对各函数，以三种直观的方式（Kiviat图、项目表和计算值分布图）提供分析结果：

如图2所示，Kiviat图直接的表达了各规则的计算值是否合乎要求，若图中计算点落在里圈和外圈之间的，被认为可接受的，处于外圈之外的，则不符合要求，需进行改进。在图2中红点表示的度规的计算值不符合要求。

项目表(见表1)描述了各个度规项的名称、助记符、计算值，另外还标出了计算值越界的规则项（用*表示）。

表1. 项目表：

计算值分布图3所示，图中标出了某一度规的上限与下限（用Lo和Hi表示），同时还表示在各取值区间的函数占总数的比例，如取值在0和43.40之间的函数占总函数的74.3%图3. 计算值分布图

a)分类标准层次

一个分类标准由一系列度规组成，在分析了相关的度规之后，给各个度规分配一个权重，由度规的取值与其权重值计算出一个分类标准的取值。在这一层次，LogiScope同样提供了Kiviat图和分类标准分布图来描述结果。

Kiviat图4所示，分类标准共四个：简单性（Simplicity），可测试性(Testability)、自描述性(Self-Descrip)和可读性(Readability)。各个分类标准又由多个度规组成，由度规的取值与其权重计算分类标准的值。

图4. Kiviat图

分类标准分布图如5图所示，提供了各分类标准在各区段所占的比例。

图5. 分类标准分布图

a)质量因素层次

图6. 质量报告

在这一层次，计算方法和表达方式与上一层次类似，依据各分类标准取值组合权重方法来计算，用Kiviat图和质量报告来描述分析结果。质量报告如图6所示：

三、LogiScope中建立质量模型的辅助工具

LogiScope的函数调用关系图、控制流图和类关系图可用于质量分析。

1）函数调用关系图

函数调用关系图以直观的图形方式描述一个应用程序中各个函数的调用和被调用关系。如图7：

图7. 函数调用关系图

2）控制流图

控制流图显示一个函数的逻辑结构，它由许多节点组成，一个节点代表一条语句或数条语句，连接结点的叫边，边表示节点间的控制流向。一个函数的控制流图如图8所示：

图8. 函数的控制流图

其中：

表示一个函数的入口和出口

表示流向控制结构的开始，如if...else、for() 、while()等

表示一序列语句

表示流向控制结构的结束

3）类关系图

（适用于C++，暂缺）

四、度规的计算法则

LogiScope提供一个应用程序提供静态的度量手段，用来分析程序的复杂性：是否易于理解、是否可读、是否方便维护、是否可靠。它在代码的不同方面，应用于程序的不同范围提供了全面的度量。具体而言，代码的不同方面包括：

-- 文本特性

-- 结构化特性

-- 数据流特性

-- 注释特性

应用于程序的不同范围包括：

-- 函数范围，包括成员函数和非成员函数

-- 类范围，C++中的类包括成员和成员函数

-- 应用程序范围

LogiScope的质量规则适用于C、C++、Ada、Assembly、Cobol、Fortran、Pascal等语言，下面仅列出在C语言中适用的规则：

1）规则定义

￡¨1￡(C)可执行语句数（STMT）

定义:函数中可执行的语句数，在函数外定义的语句不计。

说明：可执行语句数表示了一个函数的可维护性，经验表明：可执行语句数与Halstead 理论所规定的法则直接相关。越多的可执行语句数代表着可执行的

操作越多，也意味要花更多的精力去理解该函数，一个函数内的可执行语句

数应有限制。

改进：将函数分解，提供更好的层次性，提高可维护性。

￡¨1￡(C)运算符总数（n1）

定义:不同的运算符总数

下面所列均是运算符：

IF ELSE WHILE() DO WHILE()

RETURN FOR(;;) SWITCH BREAK CONTINUE

GOTO label

,

; (except in a FOR)

( ) (used to delimit an expression)

[ ] (array subscript)

- operators found in expressions:

* unary operators:

- (unary minus)

++ - - (increment or decrement)

! (negation)

sizeof

* (indirection)

& (address)

~ (complement of 1)

* binary operators:

+ - * / % (arithmetic operators)

<< >> & | ^ (bitwise operators)

> < <= >= == != (comparaison operators)

&& || (logical operators)

* conditional operator: ?:

* assignment operators:

= += -= *= /= % > >= < <= &= *= |=

- definitions of the invoked macro-commands.

说明：n1用于计算词汇频度（VOC_F）

￡¨1￡(C)运算符频度（N1）

定义:运算符的出现频度

说明：N1用于用于计算语句的平均长度（AVGS）和词汇频度（VOC_F）

￡¨1￡(C)操作数总数（n2）

定义: 不同的操作数总数

下面所列均是操作数

常量:

decimal integers (eg.: 45)

hexadecimals (eg.: 0x53 or 0X53)

octals (eg.: 0177)

reals (eg.: 2324.57)

characters (eg.: `c', or `\432')

strings (eg.: "hello ")

变量:

simple type (eg.: id1)

array type (eg.: id1[*])

record type (eg.: id1.id2.)

field pointer type (eg.: id1 -> id2)

combinaison (eg.: id1[ ] [ ] id1.id2[ ] id1[ ]-> id2)

说明：n2用于计算词汇频度（VOC_F）

￡¨1￡(C)操作数频度（N2）

定义: 操作数出现频度

说明：N2用于计算语句平均长度（AVGS）和词汇频度（VOC_F）

￡¨1￡(C)词汇频度（VOCF）

定义: 表示函数中算子和算法出现频度，计算规则是：

VOCF = (N1+N2)/ (n1+n2)

这里：

N1 是运算符出现频度

N2 是操作数出现频度

n1 是不同的运算符总数

n2 是不同的操作数总数

说明：当VOCF值过高，意味着该函数包含太近似的或甚至是重复的语句。VOCF能很好的指示一段程序的维护费用，或一段程序的稳定性。这是因为许多改动可在

每处重复的代码进行，另一方面，也说明了由于重复代码多因修改而引入错误

的风险在增大。

改进：在原代码多处重复处将语句分解为可多处调用的子函数。

￡¨1￡(C)调用函数数（CALL）

定义: 函数内调用函数的总数

如：

printf ("message 1") ;

printf ("message 2") ;

CALL value = 2

说明：当CALL值很大时，往往表明该函数具有很差的处理层次，也意味着阅读者要花很大的精力去理解程序。DRCT_CALLS也能很好的指示程序的稳定性，如果

DRCT_CALLS值很大，将使由于底层函数作修改而带来的不可预料的风险增

大。如果大量的函数被调用和许多参数被传递，这种风险将增大。

改进：限制直接调用函数的总数和调用中传递的参数。这意味着应将函数分解为新的调用，构造更新晰的处理层次。

￡¨1￡(C)直接调用函数数（DRCT_CALLS）

定义: 直接调用函数的数量，不计算同一函数的重复调用。

如：

p rintf ("message 1") ;

p rintf ("message 2") ;

DRCT_CALLS value = 1

说明：当DRCT_CALLS值很大时，往往表明该函数具有很差的处理层次，也意味着阅读者要花很大的精力去理解程序。DRCT_CALLS也能很好的指示程序的稳定

性，如果DRCT_CALLS值很大，将使由于底层函数作修改而带来的不可预料的

风险增大。如果大量的函数被调用和许多参数被传递，这种风险将增大。

改进：限制直接调用函数的总数和调用中传递的参数。这意味着应将函数分解为新的调用，构造更新晰的处理层次。

￡¨1￡(C)参数数（PARA）

定义: 函数的参数数

说明：函数的参数数指示一个函数是否具有很大的参数。这个信息表示了对该函数进行测试所花的精力，当函数的参数稍有增加时，将导致可能的执行组合大

幅度增加。一个大参数量的函数，往往意味着设计问题，尤其是该函数的程

序中实现的功能。

改进：检查函数中的参数是否真正用到，如果参数数过多，需将该函数分解成多个子处理过程，使每一子过程只使用部分使用到的参数。

￡¨1￡(C)被调用函数数（NBCALLING）

定义: 调用本函数的上级函数数

说明：NBCALLING指示了一个函数是否重要，当一个函数越多的被调用，意味着该更重要，应具有更高的可靠度。

￡¨1￡(C)注释段数（BCOM）

定义: 一个函数内的注释段数

连续的注释被计算为一段

如：

/* this is a comment */

printf ("----------------------") ;

/* this is a second */

/* comment */

printf ("----------------------") ;

/* this is a third

comment */

BCOM value = 3

在函数外的注释不被计算

说明：BCOM 被用来计算注释频度

￡¨1￡(C)局部变量数（LVAR）

定义: 局部变量数（在本函数内定义）

说明：尽管使用局部变量优于使用全局变量，但过多的局部变量对维护带来不利，因为不得不花大精力理解这些变量，当对变量理解有误时会带来风险。

改进：首先确认局部变量己全部被使用，如果变量数仍过多，将函数分解成子函数。

￡¨1￡(C)循环复杂度（VG）

定义: 在控制流图中，一个函数可能有多个入口和多个出口，应用公式如下： V(g) = E - N + 2 + AEn + AEx

其中：

E 是控制流图各节点（Node）之间的边(Edge)数

N 是控制流图的节点数

Aen 是辅助入口数（在C++语法中，Aen为0）

Aex 是辅助入口数（除函数结束的自然出口外的RETURN返回个数）

说明：不管何种控制类型：选择、循环、分支、顺序，也不管何种方式组装（顺序、嵌套、结构化），VG可用来衡量一个控制结构的复杂度。它能指示阅读

者要花多大精力去理解函数的算法，也可用来衡量做相关测试所需的时间。

也可用来指示至少要产生多少测试用例来进行测试。

改进：VG值越大，表明该函数里包含越多的可执行代码，VG过大，应想办法减少执行语句，可以分解为子函数，也可将部分代码包含到循环中。当分解为多个

子函数时，同时将复杂度也分解到多个函数，这才被认为是合理的。

￡¨1￡(C)GOTO语句数量（GOTO）

定义: GOTO语句数量

说明：函数中的GOTO语句数量必需加以限制，这为了防止过多的增加可执行路径数或产生死循环，这一规则也反映了程序的可测试性。良好的结构化程序要求

少使用或不使用GOTO语句，C++语言要求程序员不使用GOTO语句。

改进：去掉GOTO语句，改用其它语句去实现。

￡¨1￡(C)特殊的分支数（COND_STRUCT）

定义: 特殊的分支数，指BREAK 或CONTINUE分支

说明：BREAK 或CONTINUE在函数里应有限制，限制是为了防止过多的可执行路径数和产生死循环，COND_STRUCT指示了一个程序的可测试程度。

改进：删除非结构化的BREAK或CONTINUE语句，改用其它语句来实现。

￡¨1￡(C)嵌套层次（LEVL）

定义: 控制结构中最大嵌套层次再加上一

说明：LEVL用来计算最大的嵌套层次（NEST）。

￡¨1￡(C)RETURN语句数（RETU）

定义: 函数中RETURN语句数，包括函数最后的未显式使用的RETURN语句。

说明：有时使用多个RETURN语句会使编程变得简单，但当有修改产生时这种情况会使程序的不稳定性增加，当相关文件改动或相关变量改动时可能产生未期望

的结果，过多使用RETURN语句将使可维护性下降。

改进：删除除函数最后一行除外的其它RETURN语句，使用一个局部变量存放这种返回值，在函数的最后将该变量返回，当然该局部变量需初始化。

￡¨1￡(C)嵌套层数（NEST）

定义: 一个函数控制结构的最大嵌套层数

计算公式如下：

NEST = LEVL - 1

说明：当嵌套层数越大，就越难读懂代码，也不易调试，因为要记住各层入口与出口。NEST越大，在各层相符合条件累积组合，测试该函数所需的精力也越

大。

改进：当NEST值过大时，应把嵌套的代码分解为子函数。

￡¨1￡(C)未知原型函数数（UPRO）

定义: 未定义原型的函数调用数

说明：源于Kerningam & Richie C语法的程序允许一个函数可以未被声明就使用，这种使用会带来危险，UPRO用来统计这种未声明的使用。

改进：在使用前声明所有函数的原型。

￡¨1￡(C)带参数宏指令数（MACP）

定义: 函数中带参数的宏指令使用次数

如：

#define max (x,y)

var := max (1,2) ;

o ther_var := max (4,1) ;

MACP value = 2

说明：MACP 用于计算MAC

￡¨1￡(C)不带参数宏指令数（MACC）

定义: 函数中不带参数的宏指令使用次数

如：

#define true 1

v ar := true ;

o ther_var := true ;

MACC value = 2

说明：MACC用来计算MAC

￡¨1￡(C)宏指令数（MCC）

定义: 函数中宏指令使用次数

计算公式如下：

MAC = MACP + MACC

这里:

MACP 是带参数的宏指令使用次数

MACC 是不带参数的宏指令使用次数

说明：MAC用来加强检测对程序可读性和稳定性带来危害的宏指令使用。这是因为读者要在宏定义和代码之间反复跳转，如果这部分代码不被维护，当他未正

确解释该宏或在宏作修改后未作解释时，新的错误将被引入。更进一步，尽

管用宏取代函数在算法上正确的，但这种书写风格会产生很大的扩大展代

码，应该检查使用这类宏是否必要。

改进：严格限制宏指令的使用，如：如果代码效率要求并不严格时，使用函数取代宏将更好。在许多情况下，应在函数的头部指示本函数里的所使用的宏，说

明定义它的头文件名。

￡¨1￡(C)平均语句长度（AVGS）

定义: AVGS表示可执行语句的平均运算符和操作数的数量

由下述规则进行计算：

AVGS = (N1+N2) / (STMT);

这里:

N1 是运算符频度

N2 是操作数频度

STMT 是可执行语句数

说明：AVGS可以很好的指示代码的可分析性，它指出一个语句中源代码所包含的运算符和操作数的数量（平均值）

改进：一个长语句可描述为多个短语句，这样大大提高了代码的可分析性

￡¨1￡(C)程序长度（PR_LGTH）

定义: 一个函数中的运算符和操作数的总和。

计算如下：

PR_LGTH = N1 + N2

说明：PR_LGTH 用来计算语句平均大小（AVGS）和词汇频率（VOC_F）

￡¨1￡(C)注释频度（COMF）

定义: 注释频度，计算规则如下：

COMF = (BCOM+BCOB) / (STMT)

这里：

BCOM 是指一个函数里注释段的数量

BCOB 是指一个函数前注释段的数量

STMT 是指一个函数可执行语句的数量

说明：经验表明，良好的注释有助于理解代码并有益于维护，另外，对于注释应分散于函数的各部分，而不集中于函数的头部。

改进：应被指示注释量不够时，应相应增加注释描述

￡¨1￡(C)每行注释数（LCOM）

定义: 函数中每行注释数

￡¨1￡(C)函数间的注释行数（LCOB）

定义: 函数间的注释行数，上一函数结束到本函数开始部分的注释行数或文件头到函数头的注释行数。

￡¨1￡(C)函数内注释字符数（CCOM）

定义: 一个函数内注释字符数

￡¨1￡(C)函数间注释字符数（CCOB）

定义: 上一函数结束到本函数开始部分的注释字符数，或文件头到本函数头的注释字符数。

￡¨1￡(C)函数调用路径数（CALL_PATHS）

定义: 在函数调用关系图中，从组件到最未分支的调用路径数。

￡¨1￡(C)函数调用层数（LEVELS）

定义: 函数调用关系图中的层数

￡¨1￡(C)函数调用层次复杂度（HIER_CPX）

定义: 函数调用图的层次复杂度

￡¨1￡(C)函数调用结构复杂度（STRU_CPX）

定义: 函数调用图的结构复杂度

￡¨1￡(C)函数调用可测性（TESTBTY）

定义: TESTBTY用来衡量函数调用图中组件调用的宽度（调用路径）与深度（调用数量）特性。

说明：测试困难程度随函数调用图的复杂度增加和调用路径增加而增大。

￡¨1￡(C)函数调用平均信息量（ENTROPY）

定义: 函数调用图的平均信息量，ENTROPY用来表示函数调用图的是否易懂，由调用的宽度与深度特性表达。

2）度规的上下限

￡¨1￡(C)函数

助记符格式最小最大

STMT 整型 1 50

DRCT_CALLS 整型 0 7

VG 整型 1 10

GOTO 整型 0 0

RETU 整型 0 1

LVAR 整型 0 5

LEVL 整型 0 4

COMF 整型 0.2 正无穷

VOCF 浮点 1.00 4.00

AVGS 浮点 1.00 9.00

NBCALLING 浮点 0 5

PARA 整型 0 5

PATH 整型 1 80

￡¨1￡(C)函数调用

助记符格式最小最大

LEVELS 整型 1 12

HIER_CPX F浮点 1.00 5.00

STRU_CPX F浮点 0.00 3.00

ENTROPY4 浮点 1.00 3.00

CALL_PATHS 整型 1 10000

TESTBTY 浮点 0.00 1.00

￡¨1￡(C)应用程序

助记符格式最小最大

GA_LEVL 整型 2 9

GA_NODE 整型 1 3000

GA_EDGE 整型 0 10000

五、分类标准的计算法则

￡¨1￡(C)function_TESTABILITY = DRCT_CALLS + LEVL + PATH + PARA

定义：用来描述由于修改而带来的再次验证耗费量大小的特性

等级描述上限下限权重

EXCELLENT 4 4 3

GOOD 3 3 2

FAIR 2 2 1

POOR 0 1 0

￡¨1￡(C)function_STABILITY = NBCALLING + RETU + DRCT_CALLS + PARA

定义：用来描述由于对软件的修改而带来的非预期作用的风险的特性

等级描述上限下限权重

EXCELLENT 4 4 3

GOOD 3 3 2

FAIR 2 2 1

POOR 0 1 0

￡¨1￡(C)function_CHANGEABILITY = PARA + LVAR + VOCF + GOTO

定义：指对软件作修改而需消耗的费用量大小的特性

等级描述上限下限权重

EXCELLENT 4 4 3

GOOD 3 3 2

FAIR 2 2 1

POOR 0 1 0

￡¨1￡(C)function_ANALYZABILITY = VG + STMT + AVGS + COMF

定义：用来描述分析软件中缺陷（或失效）、鉴别因修改而产生的影响的效益的特性 等级描述上限下限权重

EXCELLENT 4 4 3

GOOD 3 3 2

FAIR 2 2 1

POOR 0 1 0

￡¨1￡(C)relativeCall_ANALYZABILITY = STRU_CPX + LEVELS

等级描述上限下限最终报告EXCELLENT 2 2 2

GOOD 1 1 1

POOR 0 0 0

￡¨1￡(C)relativeCall_STABILITY= CALL_PATHS + HIER_CPX

等级描述上限下限最终报告EXCELLENT 2 2 2

GOOD 1 1 1

POOR 0 0 0

￡¨1￡(C)relativeCall_TESTABILITY = TESTBTY + CALL_PATHS

等级描述上限下限最终报告EXCELLENT 2 2 2

GOOD 1 1 1

POOR 0 0 0

六、质量因素的计算法则

￡¨1￡(C)function_MAINTAINABILITY

function_MAINTAINABILITY: component = function_ANALYZABILITY +

function_CHANGEABILITY +

function_STABILITY +

function_TESTABILITY

等级描述上限下限

EXCELLENT 12 12

GOOD 8 11

FAIR 4 7

POOR 0 3

￡¨1￡(C)relativeCall_MAINTAINABILITY

relativeCall_MAINTAINABILITY: component = relativeCall_ANALYZABILITY + relativeCall_STABILITY

+ relativeCall_TESTABILITY

等级描述上限下限

EXCELLENT 6 6

GOOD 4 5

FAIR 1 3

POOR 0 0

七、质量报告自动生成

使用LogiScope工具WinDoc可以自动生成质量报告。所分析的代码要求通过静态分析，己生成静态分析结果文件（*.sta ），再输入LogiScope 的质量定义文件（如isoccpp.ref）和模板文件（Erepqual.dot）,运行WinDoc即生成代码质量报告。

一般过程如下：

在代码质量报告中，包含如下内容： - 源程序文件列表 - 分析结果分类原则: . 质量分类标准表 . 质量规则表 - 函数质量报告和分类标准分布图 - 最差质量报告: . 控制流图 . Kiviat图

生成静态分析结果文件：*.sta

进入WinDoc 生成质量报告：*.Doc

建立LogiScope 的工程文件：*.lpj