高质量C++/C编程指南学习笔记(上)
高质量C++/C编程指南学习笔记(上) 高质量C++/C编程指南学习笔记(上)
时间：2002/11/13 pm
黎锦凡
《高质量C++/C编程指南》是 林锐 博士 写的，现在已经出书了。以下是我在学习中的一些笔记，贴给大家有空看看。
1、 关于版权和版本的声明
版权和版本的声明位于头文件和定义文件的开头。示例如下：
/** Copyright (c) 2001,上海贝尔有限公司网络应用事业部
* All rights reserved.
*
* 文件名称：filename.h
* 文件标识：见配置管理计划书
* 摘 要：简要描述本文件的内容
*
* 当前版本：1.1
* 作 者：输入作者（或修改者）名字
* 完成日期：2001年7月20日
*
* 取代版本：1.0
* 原作者 ：输入原作者（或修改者）名字
* 完成日期：2001年5月10日
*/
2、 关于头文件
Ø 为了防止头文件被重复引用，应当用ifndef/define/endif结构产生预处理块。
Ø 头文件中只存放“声明”而不存放“定义”，包括内联函数最好也放在定义文件中。
Ø 尽可能少地使用全局变量，尽量不要在头文件中出现象extern int value 这类声明。
3、 源码文件的管理
如果一个软件的头文件数目比较多（如超过十个），通常应将头文件和定义文件分别保存于不同的目录，以便于维护。
例如可将头文件保存于include目录，将定义文件保存于source目录（可以是多级目录）。
如果某些头文件是私有的，它不会被用户的程序直接引用，则没有必要公开其“声明”。为了加强信息隐藏，这些私有的头文件可以和定义文件存放于同一个目录。
4、 空行的作用
在每个类声明之后、每个函数定义结束之后都要加空行。
在一个函数体内，逻揖上密切相关的语句之间不加空行，其它地方应加空行分隔。
5、 代码行
Ø 一行代码只做一件事情，如只定义一个变量，或只写一条语句。这样的代码容易阅读，并且方便于写注释。
Ø if、for、while、do等语句自占一行，执行语句不得紧跟其后。不论执行语句有多少都要加{}。这样可以防止书写失误。
Ø 尽可能在定义变量的同时初始化该变量
6、 代码行内的空格
这种东西一切都只是为了好看，就象写字一样。字写得差没人会说你，但写的不整齐就不对了。
Ø 函数名之后不要留空格，空格太多会招人烦。
Ø 赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符，如“=”、“+=” “>=”、“<=”、“+”、“*”、“%”、“&&”、“||”、“<<”,“^”等二元操作符的前后应当加空格。
Ø 一元操作符如“!”、“~”、“++”、“--”、“&”（地址运算符）等前后不加空格。
7、 关于对齐
程序的分界符‘{’和‘}’应独占一行并且位于同一列，同时与引用它们的语句左对齐。
8、 长行拆分
代码行最大长度宜控制在70至80个字符以内。代码行不要过长，否则眼睛看不过来，也不便于打印。
9、 修饰符的位置
应当将修饰符 * 和 ＆ 紧靠变量名
10、注释
Ø 注释是对代码的“提示”，而不是文档。
Ø 对每一个函数模块需注释其实现什么功能，函数的参数说明等。
Ø 注释不要太多，太多了会让人眼花缭乱。
Ø 对本身就很简单的代码句不需要去注释。
Ø 对较复杂的或比较重要的代码段需要对其实现的功能注释。
Ø 边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。
Ø 注释应当准确、易懂，防止注释有二义性。错误的注释不但无益反而有害。
Ø 尽量避免在注释中使用缩写，特别是不常用缩写。
Ø 注释的位置应放在代码的上方或右方。
Ø 当代码比较长，特别是有多重嵌套时，应当在一些段落的结束处加注释，便于阅读。
Ø 因某些原因而要屏蔽一些代码段时，应在屏蔽代码段的上方注释屏蔽的原因、操作时间和操作人。
11、类的版式
² 有两种排列方式，一种是以数据为中心，另一种是以行为中心。
² 建议将Public的函数或变量放在前面，Private的放在最后。
12、命名规则
² 标识符应当直观且可以拼读，可望文知意，不必进行“解码”。
² 标识符的长度应当符合“min-length && max-information”原则。
² 单字符的名字也是有用的，常见的如i,j,k,m,n,x,y,z等，它们通常可用作函数内的局部变量。
² 在Windows应用程序的标识符中通常采用“大小写”混排的方式，如AddChild。
² 程序中不要出现仅靠大小写区分的相似的标识符。
² 局部变量名最好不要和全局变量名相同
² 变量的名字应当使用“名词”或者“形容词＋名词”。
² 全局函数的名字应当使用“动词”或者“动词＋名词”（动宾词组）。类的成员函数应当只使用“动词”，被省略掉的名词就是对象本身。
² 用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。
² 尽量避免名字中出现数字编号，如Value1,Value2等，除非逻辑上的确需要编号。
² 类名和函数名用大写字母开头的单词组合而成。
² 变量和参数用小写字母开头的单词组合而成。
² 常量全用大写的字母，用下划线分割单词。
² 静态变量加前缀s_（表示static）。
² 如果不得已需要全局变量，则使全局变量加前缀g_（表示global）。
² 类的数据成员加前缀m_（表示member），这样可以避免数据成员与成员函数的参数同名。
² 为了防止某一软件库中的一些标识符和其它软件库中的冲突，可以为各种标识符加上能反映软件性质的前缀。例如三维图形标准OpenGL的所有库函数均以gl开头，所有常量（或宏定义）均以GL开头。
13、表达式和基本语句
² 如果代码行中的运算符比较多，用括号确定表达式的操作顺序，避免使用默认的优先级。
² 不要编写太复杂的复合表达式。
² 不要有多用途的复合表达式。
² 不要把程序中的复合表达式与“真正的数学表达式”混淆。
² 不可将布尔变量直接与TRUE、FALSE或者1、0进行比较。
² 应当将整型变量用“==”或“！=”直接与0比较
² 不可将浮点变量用“==”或“！=”与任何数字比较。
² 应当将指针变量用“==”或“！=”与NULL比较。
² 在多重循环中，如果有可能，应当将循环次数最多的循环放在最内层，最少的循环放在最外层，以减少CPU跨切循环层的次数。
² 不可在for 循环体内修改循环变量，防止for 循环失去控制。
² 建议for语句的循环控制变量的取值采用“半开半闭区间”写法。
² 每个case语句的结尾不要忘了加
break，否则将导致多个分支重叠（除非有意使多个分支重叠）。
² 不要忘记最后那个default分支。即使程序真的不需要default处理，也应该保留语句 default : break; 这样做并非多此一举，而是为了防止别人误以为你忘了default处理。
² 尽可能少地使用goto语句，但不是禁用。
14、常量的定义规则
² 常量有两种：一种是Const常量，一种是用#define定义的常量
² const的优点：const常量有数据类型，而宏常量没有数据类型。有些集成化的调试工具可以对const常量进行调试，但是不能对宏常量进行调试。
² 尽量使用常量来表示那些将在程序中要多次出现的内容。
² 需要对外公开的常量放在头文件中，不需要对外公开的常量放在定义文件的头部。
² 如果某一常量与其它常量密切相关，应在定义中包含这种关系，而不应给出一些孤立的值。
15、类中的常量 (全文摘下来，当然是有原因的了：因为我不会)
有时我们希望某些常量只在类中有效。由于#define定义的宏常量是全局的，不能达到目的，于是想当然地觉得应该用const修饰数据成员来实现。const数据成员的确是存在的，但其含义却不是我们所期望的。const数据成员只在某个对象生存期内是常量，而对于整个类而言却是可变的，因为类可以创建多个对象，不同的对象其const数据成员的值可以不同。
不能在类声明中初始化const数据成员。以下用法是错误的，因为类的对象未被创建时，编译器不知道SIZE的值是什么。
class A
{…
const int SIZE = 100; // 错误，企图在类声明中初始化const数据成员
int array[SIZE]; // 错误，未知的SIZE
};
const数据成员的初始化只能在类构造函数的初始化表中进行，例如
class A
{…
A(int size); // 构造函数
const int SIZE ;
};
A::A(int size) : SIZE(size) // 构造函数的初始化表
{
…
}
A a(100); // 对象 a 的SIZE值为100
A b(200); // 对象 b 的SIZE值为200
怎样才能建立在整个类中都恒定的常量呢？别指望const数据成员了，应该用类中的枚举常量来实现。例如
class A
{…
enum { SIZE1 = 100, SIZE2 = 200}; // 枚举常量
int array1[SIZE1];
int array2[SIZE2];
};
枚举常量不会占用对象的存储空间，它们在编译时被全部求值。枚举常量的缺点是：它的隐含数据类型是整数，其最大值有限，且不能表示浮点数（如PI=3.14159）。
16、函数设计
函数的参数和返回值的传递方式有三种：值传递（pass by value）和指针传递（pass by pointer）、引用传递（pass by reference）。
17、函数参数规则
² 参数的书写要完整，不要贪图省事只写参数的类型而省略参数名字，没有参数的函数一律使用void填充。
² 参数命名要恰当，顺序要合理。一般地，应将目的参数放在前面，源参数放在后面。
² 如果参数是指针，且仅作输入用，则应在类型前加const，以防止该指针在函数体内被意外修改。
² 如果输入参数是以值传递方式传递的，则可改用“const &”方式来传递，这样可以省去临时对象的构造和析构过程，从而提高效率。
18、函数返回值规则
² 返回值的类型应和函数声明的类型相一致。
² 不要将正常值和错误标志混在一起返回。正常值用输出参数获得，而错误标志用return语句返回。
19、函数内部实现的规则
在函数体的“入口处”，对参数的有效性进行检查。
在函数体的“出口处”，对return语句的正确性和效率进行检查。
函数内部的变量都会自动销毁，所以不要返回指向内部变量的指针。这样会出错的。如
char * Func(void)
{
char str[] = “hello world”; // str的内存位于栈上
return str; // 将导致错误
}
20、函数的其它建议
² 函数的功能要单一，不要设计多用途的函数。
² 函数体的规模要小，尽量控制在50行代码之内。
² 尽量避免函数带有“记忆”功能。也就是说尽量少用static局部变量，除非必需。
² 不仅要检查输入参数的有效性，还要检查通过其它途径进入函数体内的变量的有效性，例如全局变量、文件句柄等。
22、复制不重叠的内存块
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;
}
21、使用断言
² 使用断言捕捉不应该发生的非法情况。不要混淆非法情况与错误情况之间的区别，后者是必然存在的并且是一定要作出处理的。
² 在函数的入口处，使用断言检查参数的有效性（合法性）。
² 在编写函数时，要进行反复的考查，并且自问：“我打算做哪些假定？”一旦确定了的假定，就要使用断言对假定进行检查。
22、引用与指针的比较
引用的一些规则如下：
² 引用被创建的同时必须被初始化（指针则可以在任何时候被初始化）。
² 不能有NULL引用，引用必须与合法的存储单元关联（指针则可以是NULL）。
² 一旦引用被初始化，就不能改变引用的关系（指针则可以随时改变所指的对象）。
“引用传递”的性质象“指针传递”，而书写方式象“值传递”。实际上“引用”可以做的任何事情“指针”也都能够做。
23、内存分配方式
² 从静态存储区域分配。内存在程序编译的时候就已经分配好，这块内存在程序的整个运行期间都存在。例如全局变量，static变量。
² 在栈上创建。在执行函数时，函数内局部变量的存储单元都可以在栈上创建，函数执行结束时这些存储单元自动被释放。栈内存分配运算内置于处理器的指令集中，效率很高，但是分配的内存容量有限。
² 从堆上分配，亦称动态内存分配。程序在运行的时候用malloc或new申请任意多少的内存，程序员自己负责在何时用free或delete释放内存。动态内存的生存期由我们决定，使用非常灵活，但问题也最多。
24、常见的内存错误及其对策
1)、内存分配未成功，却使用了它。
解决办法：在使用内存之前检查指针是否为NULL。如果指针p是函数的参数，那么在函数的入口处用assert(p!=NULL)进行检查。如果是用malloc或new来申请内存，应该用if(p==NULL) 或if(p!=NULL)进行防错处理。
2)、内存分配虽然成功，但是尚未初始化就引用它。
解决办法：别忘了给内存赋初值，即便是赋零值也不可省略，不要嫌麻烦。
3)、内存分配成功并且已经初始化，但操作越过了内存的边界。
解决办法：例如在使用数组时经常发生下标“多1”或者“少1”的操作。
4)、忘记了释放内存，造成内存泄露。
动态内存的申请与释放必须配对，程序中malloc与free的使用次数一定要相同，否则肯定有错误（new/delete同理）。
5）、释放了内存却继续使用它。
有三种情况：
（1）程序中的对象调用关系过于复杂，实在难以搞清楚某个对象究竟是否已经释放了内存，此时应该重新设计数据结构，从根本上解决对象管理的混乱局面。
（2）函数的return语句写错了，注意不要返回指向“栈内存”的“指针”或者“引用”，因为该内存在函数体结束时被自动销毁。
（3）使用free或delete释放了内存后，没有将指针设置为NULL。导致产生“野指针”。
25、内存使用规则
² 用malloc或new申请内存之后，应该立即检查指针值是否为NULL。防止使用指针值为NULL的内存。
² 不要忘记为数组和动态内存赋初值。防止将未被初始化的内存作为右值使用。
² 避免数组或指针的下标越界，特别要当心发生“多1”或者“少1”操作。
² 动态内存的申请与释放必须配对，防止内存泄漏。
² 用free或delete释放了内存之后，立即将指针设置为NULL，防止产生“野指针”。
