C语言函数设计的一般原则和技巧
1、原则上尽量少使用全局变量,因为全局变量的生命周期太长,容易出错,也会长时间占用空间.各个源文件负责本身文件的全局变量,同时提供一对对外函数,方便其它函数使用该函数来访问变量。
比如:niSet_ValueName(…);niGet_ValueName(…);不要直接读写全局变量,尤其是在多线程编程时,必须使用这种方式,并且对读写操作加锁。
2、参数命名要恰当,顺序要合理。
例如编写字符串拷贝函数str_copy,它有两个参数。如果把参数名字起为str1 和str2,例如
void str_copy (char *str1, char *str2);
那么我们很难搞清楚究竟是把str1 拷贝到str2 中,还是刚好倒过来。
可以把参数名字起得更有意义,如叫strSource 和strDestination。这样从名字上就可以看出应该把strSource 拷贝到strDestination。
还有一个问题,这两个参数那一个该在前那一个该在后?参数的顺序要遵循程序员的习惯。一般地,应将目的参数放在前面,源参数放在后面。如果将函数声明为:
void str_copy (char *strSource, char *strDestination);
别人在使用时可能会不假思索地写成如下形式:
char str[20];
str_copy (str, “Hello World”); 参数顺序颠倒
3、如果参数是指针,且仅作输入参数用,则应在类型前加const,以防止该指针在函数体内被意外修改。例如:
void str_copy (char *strDestination,const char *strSource);
4、不要省略返回值的类型,如果函数没有返回值,那么应声明为void 类型。
如果没有返回值,编译器则默认为函数的返回值是int类型的。
5、在函数体的“入口处”,对参数的有效性进行检查。尤其是指针参数,尽量使用assert宏做入口校验,而不使用if语句校验。(关于此问题讨论,详见指针与数组那章。)
6、return 语句不可返回指向“栈内存”的“指针”,因为该内存在函数体结束时被自动销毁。例如:
char * Func(void)
{
char str[30];
…
return str;
}
str 属于局部变量,位于栈内存中,在Func 结束的时候被释放,所以返回str 将导致错误。
7、函数的功能要单一,不要设计多用途的函数。微软的Win32 API就是违反本规则的典型,其函数往往因为参数不一样而功能不一,导致很多初学者迷惑。
8、函数体的规模要小,尽量控制在80 行代码之内。
9、相同的输入应当产生相同的输出。尽量避免函数带有“记忆”功能。
带有“记忆”功能的函数,其行为可能是不可预测的,因为它的行为可能取决于某种“记忆状态“。这样的函数既不易理解又不利于测试和维护。在C 语言中,函数的static局部变量是函数的“记忆”存储器。建议尽量少用static 局部变量,除非必需。
10、避免函数有太多的参数,参数个数尽量控制在4个或4个以内。如果参数太多,在使用时容易将参数类型或顺序搞错。微软的Win32 API就是违反本规则的典型,其函数的参数往往七八个甚至十余个。比如一个CreateWindow函数的参数就达11个之多。
11、尽量不要使用类型和数目不确定的参数。
C 标准库函数printf 是采用不确定参数的典型代表,其原型为:
int printf(const chat *format[, argument]…);
这种风格的函数在编译时丧失了严格的类型安全检查。
12、有时候函数不需要返回值,但为了增加灵活性如支持链式表达,可以附加返回值。例如字符串拷贝函数strcpy 的原型:
char *strcpy(char *strDest,const char *strSrc);
strcpy 函数将strSrc 拷贝至输出参数strDest 中,同时函数的返回值又是strDest。这样做并非多此一举,可以获得如下灵活性:
char str[20];
int length = strlen(strcpy(str, “Hello World”) );
13、不仅要检查输入参数的有效性,还要检查通过其它途径进入函数体内的变量的有效性,例如全局变量、文件句柄等。
14、函数名与返回值类型在语义上不可冲突。
违反这条规则的典型代表就是C语言标准库函数getchar。几乎没有一部名著没有提到getchar函数,因为它实在太经典,太容易让人犯错误了。所以,每一个有经验的作者都会拿这个例子来警示他的读者,我这里也是如此:
char c;
c = getchar();
if(EOF == c)
{
…
}
按照getchar 名字的意思,应该将变量c 定义为char 类型。但是很不幸,getchar 函数的返回值却是int 类型,其原型为:
int getchar(void);
由于c 是char 类型的,取值范围是[-128,127],如果宏EOF 的值在char 的取值范围之外,EOF 的值将无法全部保存到c 内,会发生截断,将EOF 值的低8 位保存到c 里。这样if 语句有可能总是失败。这种潜在的危险,如果不是犯过一次错,肯怕很难发现。
比如:niSet_ValueName(…);niGet_ValueName(…);不要直接读写全局变量,尤其是在多线程编程时,必须使用这种方式,并且对读写操作加锁。
2、参数命名要恰当,顺序要合理。
例如编写字符串拷贝函数str_copy,它有两个参数。如果把参数名字起为str1 和str2,例如
void str_copy (char *str1, char *str2);
那么我们很难搞清楚究竟是把str1 拷贝到str2 中,还是刚好倒过来。
可以把参数名字起得更有意义,如叫strSource 和strDestination。这样从名字上就可以看出应该把strSource 拷贝到strDestination。
还有一个问题,这两个参数那一个该在前那一个该在后?参数的顺序要遵循程序员的习惯。一般地,应将目的参数放在前面,源参数放在后面。如果将函数声明为:
void str_copy (char *strSource, char *strDestination);
别人在使用时可能会不假思索地写成如下形式:
char str[20];
str_copy (str, “Hello World”); 参数顺序颠倒
3、如果参数是指针,且仅作输入参数用,则应在类型前加const,以防止该指针在函数体内被意外修改。例如:
void str_copy (char *strDestination,const char *strSource);
4、不要省略返回值的类型,如果函数没有返回值,那么应声明为void 类型。
如果没有返回值,编译器则默认为函数的返回值是int类型的。
5、在函数体的“入口处”,对参数的有效性进行检查。尤其是指针参数,尽量使用assert宏做入口校验,而不使用if语句校验。(关于此问题讨论,详见指针与数组那章。)
6、return 语句不可返回指向“栈内存”的“指针”,因为该内存在函数体结束时被自动销毁。例如:
char * Func(void)
{
char str[30];
…
return str;
}
str 属于局部变量,位于栈内存中,在Func 结束的时候被释放,所以返回str 将导致错误。
7、函数的功能要单一,不要设计多用途的函数。微软的Win32 API就是违反本规则的典型,其函数往往因为参数不一样而功能不一,导致很多初学者迷惑。
8、函数体的规模要小,尽量控制在80 行代码之内。
9、相同的输入应当产生相同的输出。尽量避免函数带有“记忆”功能。
带有“记忆”功能的函数,其行为可能是不可预测的,因为它的行为可能取决于某种“记忆状态“。这样的函数既不易理解又不利于测试和维护。在C 语言中,函数的static局部变量是函数的“记忆”存储器。建议尽量少用static 局部变量,除非必需。
10、避免函数有太多的参数,参数个数尽量控制在4个或4个以内。如果参数太多,在使用时容易将参数类型或顺序搞错。微软的Win32 API就是违反本规则的典型,其函数的参数往往七八个甚至十余个。比如一个CreateWindow函数的参数就达11个之多。
11、尽量不要使用类型和数目不确定的参数。
C 标准库函数printf 是采用不确定参数的典型代表,其原型为:
int printf(const chat *format[, argument]…);
这种风格的函数在编译时丧失了严格的类型安全检查。
12、有时候函数不需要返回值,但为了增加灵活性如支持链式表达,可以附加返回值。例如字符串拷贝函数strcpy 的原型:
char *strcpy(char *strDest,const char *strSrc);
strcpy 函数将strSrc 拷贝至输出参数strDest 中,同时函数的返回值又是strDest。这样做并非多此一举,可以获得如下灵活性:
char str[20];
int length = strlen(strcpy(str, “Hello World”) );
13、不仅要检查输入参数的有效性,还要检查通过其它途径进入函数体内的变量的有效性,例如全局变量、文件句柄等。
14、函数名与返回值类型在语义上不可冲突。
违反这条规则的典型代表就是C语言标准库函数getchar。几乎没有一部名著没有提到getchar函数,因为它实在太经典,太容易让人犯错误了。所以,每一个有经验的作者都会拿这个例子来警示他的读者,我这里也是如此:
char c;
c = getchar();
if(EOF == c)
{
…
}
按照getchar 名字的意思,应该将变量c 定义为char 类型。但是很不幸,getchar 函数的返回值却是int 类型,其原型为:
int getchar(void);
由于c 是char 类型的,取值范围是[-128,127],如果宏EOF 的值在char 的取值范围之外,EOF 的值将无法全部保存到c 内,会发生截断,将EOF 值的低8 位保存到c 里。这样if 语句有可能总是失败。这种潜在的危险,如果不是犯过一次错,肯怕很难发现。