第六章 高质量C编程规范函数设计

1. C 语言中,函数的参数和返回值的传递方式有两种:值传递(pass byvalue)和指针传递(pass by pointer)。C++ 语言中多了引用传递(pass by reference)。

2.参数的规则

(1)参数的书写要完整,不要贪图省事只写参数的类型而省略参数名字(指的是在函数声明的时候)。如果函数没有参数,则用void填充。

(2)参数命名要恰当,顺序要合理。一般地,应将目的参数放在前面,源参数放在后面。

void StringCopy(char *str1, char *str2);

void StringCopy(char * strDestination, char*strSource);

两者相比较,第二种函数声明的方式就明显优于第一种函数声明方式。

(3)如果参数是指针,且仅作输入用,则应在类型前加const,以防止该指针在函数体内被意外修改。

例如:void StringCopy(char *strDestination,const char*strSource);

(4)如果输入参数以值传递的方式传递对象,则宜改用“const&”方式来传递(传递对象的地址,而不是传递对象),这样可以省去临时对象的构造和析构过程,从而提高效率。

(5)避免函数有太多的参数,参数个数尽量控制在5个以内。如果参数太多,在使用时容易将参数类型或顺序搞错。

(6)尽量不要使用类型和数目不确定的参数。

C 标准库函数printf 是采用不确定参数的典型代表,其原型为:

int printf(const chat *format[, argument]…);

这种风格的函数在编译时丧失了严格的类型安全检查。

3.返回值的规则

(1)不要省略返回值的类型。

在C语言不加返回值类型按自动类型处理。然而C++语言有很严格的类型安全检查,不允许不加返回值类型的情况发生。由于C++程序可以调用C函数,为了避免混乱,规定任何C++/C 函数都必须有类型。如果函数没有返回值,那么应声明为void 类型。

(2)函数名字与返回值类型在语义上不可冲突。

函数名字与返回值类型在语义上不可冲突。

//int getchar(void);

char c;

c = getchar();

if (c == EOF)

由于c 是char 类型,取值范围是[-128,127],如果宏EOF 的值在char的取值范围之外,那么if 语句将总是失败。

(3)不要将正常值和错误标志混在一起返回。正常值用输出参数获得(传递单元的地址),而错误标志用return 语句返回。

建议:(1)有时候函数原本不需要返回值,但为了增加灵活性如支持链式表达,可以附加返回值。

例如:int length = strlen( strcpy(str, “Hello World”));

(2)如果函数的返回值是一个对象,有些场合用“引用传递”替换“值传递”可以提高效率。而有些场合只能用“值传递”而不能用“引用传递”,否则会出错。

(3)如果函数的返回值是一个对象,有些场合用“引用传递”替换“值传递”可以提高效率。而有些场合只能用“值传递”而不能用“引用传递”,否则会出错。

例如:

class String

{…

// 赋值函数

String & operate=(const String&other);

// 相加函数,如果没有friend 修饰则只许有一个右侧参数

friend String operate+( const String&s1, const String &s2);

private:

char *m_data;

}

String 的赋值函数operate = 的实现如下:

String & String::operate=(constString &other)

{

if (this == &other)

return *this;

delete m_data;

m_data = new char[strlen(other.data)+1];

strcpy(m_data, other.data);

return *this; // 返回的是 *this 的引用,无需拷贝过程

}

对于赋值函数,应当用“引用传递”的方式返回String对象。如果用“值传递”的方式,虽然功能仍然正确,但由于return 语句要把 *this拷贝到保存返回值的外部存储单元之中,增加了不必要的开销,降低了赋值函数的效率。例如:

String a,b,c;

a = b; // 如果用“值传递”,将产生一次 *this 拷贝

a = b = c; // 如果用“值传递”,将产生两次 *this 拷贝

String 的相加函数operate + 的实现如下:

String operate+(const String &s1,const String &s2)

{

String temp;

delete temp.data; // temp.data 是仅含‘\0’的字符串

temp.data = new char[strlen(s1.data) +strlen(s2.data) +1];

strcpy(temp.data, s1.data);

strcat(temp.data, s2.data);

return temp;

}

对于相加函数,应当用“值传递”的方式返回String对象。如果改用“引用传递”,那么函数返回值是一个指向局部对象temp 的“引用”。由于temp在函数结束时被自动销毁,将导致返回的“引用”无效。例如:

c = a + b;

此时 a + b 并不返回期望值,c 什么也得不到,流下了隐患。

注意:上面讨论的是返回值,不是形参和实参。

4.函数内部实现规则

(1)在函数体的“入口处”,对参数的有效性进行检查。

应该充分理解并正确使用“断言”(assert)来防止此类错误。

(2)在函数体的“出口处”,对return 语句的正确性和效率进行检查。

①(1)return语句不可返回指向“栈内存”的“指针”或者“引用”,因为该内存在函数体结束时被自动销毁。

②如果函数返回值是一个对象,要考虑return 语句的效率。例如:

return String(s1 + s2);

这是临时对象的语法,表示“创建一个临时对象并返回它”。不要以为它与“先创建一个局部对象temp并返回它的结果”是等价的,如

String temp(s1 + s2);

return temp;

实质不然,上述代码将发生三件事。首先,temp 对象被创建,同时完成初始化;然后拷贝构造函数把temp拷贝到保存返回值的外部存储单元中;最后,temp在函数结束时被销毁(调用析构函数)。然而“创建一个临时对象并返回它”的过程是不同的,编译器直接把临时对象创建并初始化在外部存储单元中,省去了拷贝和析构的化费,提高了效率。

类似地,我们不要将

return int(x + y); // 创建一个临时变量并返回它

写成

int temp = x + y;

return temp;

由于内部数据类型如int,float,double的变量不存在构造函数与析构函数,虽然该“临时变量的语法”不会提高多少效率,但是程序更加简洁易读。

其他建议

(1)函数的功能要单一,不要设计多用途的函数。

(2)函数体的规模要小,尽量控制在50 行代码之内。

(3)尽量避免函数带有“记忆”功能。相同的输入应当产生相同的输出。在C/C++语言中,函数的static局部变量是函数的“记忆”存储器。建议尽量少用static 局部变量,除非必需。

(4)不仅要检查输入参数的有效性,还要检查通过其它途径进入函数体内的变量的有效性,例如全局变量、文件句柄等。

(5)用于出错处理的返回值一定要清楚,让使用者不容易忽视或误解错误情况。

5.断言的使用

程序一般分为Debug 版本和Release 版本,Debug 版本用于内部调试,Release版本发行给用户使用。断言assert 是仅在Debug 版本起作用的宏,它用于检查“不应该”发生的情况。在运行过程中,如果assert的参数为假,那么程序就会中止(一般地还会出现提示对话,说明在什么地方引发了assert)。

例如:assert((pvTo != NULL)&& (pvFrom != NULL)); // 使用断言

assert 不是一个仓促拼凑起来的宏。为了不在程序的Debug 版本和Release版本引起差别,assert 不应该产生任何副作用。所以assert不是函数,而是宏。程序员可以把assert看成一个在任何系统状态下都可以安全使用的无害测试手段。如果程序在assert处终止了,并不是说含有该assert 的函数有错误,而是调用者出了差错,assert 可以帮助我们找到发生错误的原因。

注意:使用断言,一定要在后面加上注释说明该断言的作用。

常用的使用断言的地方:

(1)使用断言捕捉不应该发生的非法情况。不要混淆非法情况与错误情况之间的区别,后者是必然存在的并且是一定要作出处理的。

(2)在函数的入口处,使用断言检查参数的有效性(合法性)。

(3)在编写函数时,要进行反复的考查,并且自问:“我打算做哪些假定?”一旦确定了的假定,就要使用断言对假定进行检查。

(4)一般教科书都鼓励程序员们进行防错设计,但要记住这种编程风格可能会隐瞒错误。当进行防错设计时,如果“不可能发生”的事情的确发生了,则要使用断言进行报警。

6.指针引用的区别

(1)引用被创建的同时必须被初始化(指针则可以在任何时候被初始化)。

(2)不能有NULL 引用,引用必须与合法的存储单元关联(指针则可以是NULL)。

(3)一旦引用被初始化,就不能改变引用的关系(指针则可以随时改变所指的对象)。

实际上“引用”可以做的任何事情“指针”也都能够做,为什么还要“引用”这东西?答案是“用适当的工具做恰如其分的工作”。指针能够毫无约束地操作内存中的如何东西,尽管指针功能强大,但是非常危险。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值