高质量C/C++编程指南总结（六）—— 函数

1. 函数参数的规则

• 函数参数书写要完整，若没有参数，则用 void 填充。
• 函数参数的名称要有意义。对于 strcpy 等功能的函数，要将目的参数写在前面，源参数放在后面。
• 参数是指针类型，并且仅作为输入用的，应在类型前加 const，以防止该指针在函数体内被意外修改。
• C++中参数是以值传递的方式传递对象的，宜改用“const &”引用的方式来传递，这样可以省去临时对象的构造和析构过程，从而提高效率。
• 避免函数有太多的参数，参数个数尽量控制在 5 个以内。
• 尽量不要使用类型和数目不确定的参数。例如 printf 函数，这种风格的函数在编译时丧失了严格的类型安全检查。

2. 返回值的规则

• 不要省略返回值的类型。
• 函数名字与返回值类型在语义上不可冲突。不要将正常值和错误标志混在一起返回。正常值用输出参数获得，而错误标志用 return 语句返回。
  • 例如 getchar：返回值类型为 int，但字面上会认为返回值是 char 类型。
• 有时候函数原本不需要返回值，但为了增加灵活性如支持链式表达，可以附加返回值。如果函数的返回值是一个对象，有些场合用“引用传递”替换“值传递”可以提高效率。而有些场合只能用“值传递”而不能用“引用传递”，否则会出错。
  • 例如 strcpy 函数的原型：char *strcpy（char *strDest，const char *strSrc）

3. 函数内部实现的规则

• 在函数体的“入口处”，对参数的有效性进行检查。理解并正确使用“断言”（ assert）来防止此类错误。
• 在函数体的“出口处”，对 return 语句的正确性和效率进行检查。
  • return 语句不可返回指向“栈内存”的“指针”或者“引用”，因为该内存在函数体结束时被自动销毁。

char * Func(void)
{
    char str[] = “hello world”; // str 的内存位于栈上
    ...
    return str; // 将导致错误
}

• 要搞清楚返回的究竟是“值”、 “指针”还是“引用”。
• 如果函数返回值是一个对象，要考虑 return 语句的效率。
  • 例如：return String（s1 + s2）；

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

String temp（s1 + s2）；

return temp;

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

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

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

4. 其它建议

• 函数的功能要单一，不要设计多用途的函数。
• 函数体的规模要小，尽量控制在 200行代码之内。
• 尽量避免函数带有“记忆”功能。相同的输入应当产生相同的输出。带有“记忆”功能的函数，其行为可能是不可预测的，因为它的行为可能取决于某种“记忆状态”。这样的函数既不易理解又不利于测试和维护。所以建议少用 static 变量。
• 不仅要检查输入参数的有效性，还要检查通过其它途径进入函数体内的变量的有效性，例如全局变量、文件句柄等。
• 用于出错处理的返回值一定要清楚，让使用者不容易忽视或误解错误情况。

5. 使用断言

• 在运行过程中，如果 assert 的参数为假，那么程序就会中止。
• 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;
}

6. 引用和指针的区别

• 引用被创建的同时必须被初始化（指针则可以在任何时候被初始化）。
• 不能有 NULL 引用，引用必须与合法的存储单元关联（指针则可以是 NULL）。
• 一旦引用被初始化，就不能改变引用的关系（指针则可以随时改变所指的对象）。