C/C++高质量编程之函数设计

函数是C/C++语言的基本功能单元，非常重要，本章学习函数的接口设计和内部实现的一些规则。

一、参数

1.函数的参数必须写完整，不要省略参数名字，如果没有参数，则用void说明：

int fun(int a, int b);
int fun(void);

2.参数的命名要恰当，顺序要合理，一般将目的参数放在前面，源参数放在后面。

3.若参数为指针，仅作输入用，应该在类型前面加const，防止该指针在函数体内被意外修改：

void fun(char *ptr, const char *str);

4.如果输入参数以值传递，用“const &”的方式来传递可以神曲临时对象的构造和析构过程，从而提高效率。

5.建议避免参数过多和使用类型及树木都不确定的参数：

int printf(const char *format[]);  //printf是采用的不确定参数典型代表，在编译时丧失了类型安全检查

二、返回值的规则

1.不要省略返回值的类型，因为没有类型说明，都是自动按整型处理，会导致很多错误出现。

2.函数名字和返回值类型在语义上不要冲突：

char c;
c = getchar();   //getchar的原型为int型，c为char型，这样势必会出错

3.正常值用输出参数获得，错误标志用return语句返回。

三、函数内部的实现规则

1.在函数的入口处，对参数的有效性进行检查，可用“断言”来防止这类错误。断言在下面有介绍。

2.在函数体的出口处，对return语句的正确性和效率进行检查：

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

char *func(void)
{
   char str[] = "hello world"; //str的内存在栈上
   ........

   return str;    //将导致错误
}

搞清楚返回的是“值”、“指针”、还是“引用”，同时也要考虑return的效率：

return int(x + y);  


int a = x + y;
return a;             这里明显降低了效率

4.函数的功能要单一、规模不要太大、输入与输出应该相同。

  

   避免函数带有记忆功能，这样的函数既不利于理解又不利于维护和测试，函数的static局部变量是函数的“记忆”存储器，少用static局部变量

  

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

  

   用于出错处理的返回值一定要清楚。

四、使用断言

   程序一般分为Debug版本和Release版本，前者用于内部调试，后者发行给用户使用。

   断言assert是仅在Debug版本起作用的宏，用于检查“不应该”发生的情况。如果assert的参数为假，则程序会中止：

void *memcpy(void *pvTo, const void *pvFrom, size_t size)
{
     assert((pvTo |= NULL) && (pvFrom |= NULL));      //使用断言
     byte *pbTo = (byte *) pvTo;                      //防止改变pvTo的地址
     byte *pbFrom = (byte *) pvFrom;                  //防止改变pvFrom的地址
     while(size --> 0)
           *pbTo ++ = *pbFrom ++;
     return pvTo;
}

这个例子是一个内存复制函数。

1.使用断言捕捉不应该发生的非法情况。

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

五、引用与指针的比较

在C++中，引用的概念很常见：

int m;
int &n = m;

n相当于m的别名，对n的任何操作就是对m的操作。

1.引用被创建的同时必须被初始化，指针则可以在任何时候被初始化；

2.NULL引用是不允许的，引用必须与合法的存储单元关联，指针则可以是NULL；

3.不要改变引用的关系，指针则可以随时改变所指对象。

引用的主要功能是传递函数的参数和返回值，函数的参数和返回值的传递方式有三种：值传递、指针传递和引用传递：

void Func1(int x)
{
   x = x + 10;
}
...
int n = 0;
Func1(n);
cout << "n = " << n << endl;  //n=0

这是值传递的例子，改变x的值不会影响n，所以n的值仍然是0。

void Func2(int *x)
{
    (* x) = (* x) + 10;
}
...
int n = 0;
Func2(&n);
cout << "n = " << n << endl;   //n = 10

上面是指针传递的实例，n的值将会改变。

下面是引用传递的实例，n的值也被改变了：

void Func3(int &x)
{
    x = x + 10;
}
...
int n = 0;
Func3(n);
cout << "n = " << n << endl;  //n=10

函数设计规则是我们在写代码时最容易忽视的，所以有时候函数出错要检查是否违反了某些规则。