C语言编程规范--------7 可测性

7.1 准备测试代码、测试用例

(1)编程的同时要为单元测试选择恰当的测试点,并仔细构造测试代码、测试用例,同时给出明确的注释说明。测试代码部分应作为(模块中的)一个子模块,以方便测试代码在模块中的安装与拆卸(通过调测开关)

(2)在进行集成测试/ 系统联调之前,要构造好测试环境、测试项目及测试用例,同时仔细分析并优化测试用例,以提高测试效率。好的测试用例应尽可能模拟出程序所遇到的边界值、各种复杂环境及一些极端情况等。

(3)在编写代码之前,应预先设计好程序调试与测试的方法和手段,并设计好各种调测开关及相应测试代码如打印函数等。程序的调试与测试是软件生存周期中很重要的一个阶段,如何对软件进行较全面、高率的测试并尽可能地找出软件中的错误就成为很关键的问题。因此在编写源代码之前,除了要有一套比较完善的测试计划外,还应设计出一系列代码测试手段,为单元测试、集成测试及系统联调提供方便。

7.2 使用断言来发现软件问题,提高代码可测性

(1)断言是对某种假设条件进行检查(可理解为若条件成立则无动作,否则应报告),它可以快速发现并定位软件问题,同时对系统错误进行自动报警。断言可以对在系统中隐藏很深,用其它手段极难发现的问题进行定位,从而缩短软件问题定位时间,提高系统的可测性。实际应用时,可根据具体情况灵活地设计断言。

示例:下面是C语言中的一个断言,用宏来设计的。(其中NULL为0L)

#ifdef _EXAM_ASSERT_TEST_  // 若使用断言测试

void exam_assert( char * file_name, unsigned int line_no )

{

printf( "\n[EXAM]Assert failed: %s, line %u\n",

file_name, line_no );

abort( );

}

#define  EXAM_ASSERT( condition )

if (condition) // 若条件成立,则无动作

NULL;

else  // 否则报告

exam_assert( __FILE__, __LINE__ )

#else  // 若不使用断言测试

#define EXAM_ASSERT(condition)  NULL

#endif  /* end of ASSERT */

(2)用断言来检查程序正常运行时不应发生但在调测时有可能发生的非法情况。

(3)不能用断言来检查最终产品肯定会出现且必须处理的错误情况。断言是用来处理不应该发生的错误情况的,对于可能会发生的且必须处理的情况要写防错程序,而不是断言。如某模块收到其它模块或链路上的消息后,要对消息的合理性进行检查,此过程为正常的错误检查,不能用断言来实现。

(4)对较复杂的断言加上明确的注释,澄清断言含义并减少不必要的误用。

(5)用断言确认函数的参数。示例:假设某函数参数中有一个指针,那么使用指针前可对它检查,如下。

int exam_fun( unsigned char *str )

{

EXAM_ASSERT( str != NULL );  // 用断言检查“假设指针不为空”这个条件

... //other program code

}

7.3 版本控制

(1)正式软件产品中应把断言及其它调测代码去掉(即把有关的调测开关关掉),加快软件运行速度。

(2)在软件系统中设置与取消有关测试手段,不能对软件实现的功能等产生影响——即有测试代码的软件和关掉测试代码的软件,在功能行为上应一致。

(3)用调测开关来切换软件的DEBUG 版和正式版,而不要同时存在正式版本和DEBUG 版本的不同源文件,以减少维护的难度

(4)软件的DEBUG 版本和发行版本应该统一维护,不允许分家,并且要时刻注意保证两个版本在实现功能上的一致性。

时间: 2024-11-12 01:02:46

C语言编程规范--------7 可测性的相关文章

华为C语言编程规范

DKBA华为技术有限公司内部技术规范DKBA 2826-2011.5C语言编程规范2011年5月9日发布 2011年5月9日实施华为技术有限公司Huawei Technologies Co., Ltd.版权所有 侵权必究All rights reserved密级:confidentiality levelDKBA 2826-2011.52011-06-02 华为机密,未经许可不得扩散 Huawei Confidential 第2页,共61页Page 2 , Total61修订声明Revision

C语言编程规范

C语言编程规范 6 函数与过程 6.1 函数的功能与规模设计 函数应当短而精美,而且只做一件事.不要设计多用途面面俱到的函数,多功能集于一身的函数,很可能使函数的理解.测试.维护等变得困难. 6.2 函数的返回值 (1)对于函数的返回位置,尽量保持单一性,即一个函数尽量做到只有一个返回位置.(单入口单出口). 要求大家统一函数的返回值,所有的函数的返回值都将以编码的方式返回. 例如编码定义如下: #define CM_POINT_IS_NULL CMMAKEHR(0X200) : : 参考函数实

Golang语言编程规范

Golang语言编程规范 一.说明 编程规范好,可避免语言陷阱,可有利团队协作,有利项目维护. 正常的Go编程规范有两种:编译器强制的(必须的),gofmt格式化非强制的(非必须). Go宣告支持驼峰命名法,排斥下划线法. 自定义原则: a.统一工作区间,避免目录及文件名随意 b.规范变量/结构体/方法及接口名 c.规范注释 d.单元测试/程序效率等建议 两个等级: (S)建议,(M)必须.以下是细节. 二.代码组织结构 (M)一个目录只包含一个包,模块复杂拆分子模块/子目录 (S)内部项目GO

C语言编程规范试题(标准答案)

一.单选题(每小题3分,共20小题60分) 1.1-1.5    B D A C B                1.6-1.10    C A D B C 1.11-1.15  A D D C B                1.16-1.20   D A B C A 二.填空题(每空1分,共20空20分) 2.1 通常在设计函数的时候,函数之间要低 耦合 ,函数内部要高 内聚 ,函数之间调用关系要 高 扇入. 合理 扇出. 2.2 为了提高代码的效率,通常要求循环体内工作量 最小化 ,把

C语言编程规范概要

编程规范概要 1. 程序结构清析,简单易懂,单个函数的程序行数不得超过100行. 2. 打算干什么,要简单,直截了当,代码精简,避免垃圾程序. 3. 尽量使用标准库函数和公共函数. 4. 不要随意定义全局变量,尽量使用局部变量. 5. 使用括号以避免二义性. 可读性要求 1.可读性第一,效率第二. 2.保持注释与代码完全一致. 3.每个源程序文件,都有文件头说明,说明规格见规范. 4.每个函数,都有函数头说明,说明规格见规范. 5.主要变量(结构.联合.类或对象)定义或引用时,注释能反映其含义.

C语言编程规范试题

[说明]: 1.本试题中不考虑头文件引用问题(假定已经包含正确的头文件),C语言的标准函数都可用: 2.如果不特别说明,假定程序运行环境为:操作系统Windows 2000, VC6.0编译环境,缺省为四字节对齐,X86(80586)CPU处理器(32位小字节序处理器): 3.试卷需要回收再利用,请在答题纸上答题: 4.本试题满分为100分,答题时间为90分钟. 一.单选题(每小题3分,共20小题60分) (  )1.1 程序块要采用缩进风格编写,缩进的空格数为几个? A. 2    B. 4 

C语言编程规范—命名规则

转载自:http://www.cnblogs.com/wfwenchao/p/5209197.html C是一门朴素的语言,你使用的命名也应该这样.与Modula-2和Pascal程序员不同,C程序员不使用诸如"ThisVariableIsATemporaryCounter"这样"聪明"的名字.C程序员应该叫它"tmp",这写起来更简单,也不会更难懂.然而,当面对复杂情况时就有些棘手,给全局变量取一个描述性的名字是必要的.把一个全局函数叫做&qu

C语言编程规范--------9 质量保证

(1)在软件设计过程中构筑软件质量. (2)代码质量保证优先原则: ①正确性,指程序要实现设计要求的功能. ②稳定性.安全性,指程序稳定.可靠.安全. ③可测试性,指程序要具有良好的可测试性. ④规范/可读性,指程序书写风格.命名规则等要符合规范. (3)只引用属于自己的存贮空间.若模块封装的较好,那么一般不会发生非法引用他人的空间. (3)防止引用已经释放的内存空间.在实际编程过程中,稍不留心就会出现在一个模块中释放了某个内存块(如C语言指针),而另一模块在随后的某个时刻又使用了它.要防止这种

C语言编程规范--------2 注释

2.1 注释的原则 注释的目的是解释代码的目的.功能和采用的方法,提供代码以外的信息,帮助读者理解代码,防止没必要的重复注释信息. 示例:如下注释意义不大. /* if receive_flag is TRUE */ if (receive_flag) 而如下的注释则给出了额外有用的信息. /* if mtp receive a message from links */ if (receive_flag) 2.2 说明性文件头部应进行注释 说明性文件(如头文件.h 文件..inc 文件..de