读书笔记——《高质量 C++/C 编程指南》（1）-易微帮

（1）源代码不便（或不准）向用户公布，只要向用户提供头文件和二进制的库即可。用户只需要按照头文件中的接口声明来调用库功能，而不必关心接口怎么实现的。编译器会从库中提取相应的代码。
（2）头文件能加强类型安全检查。如果某个接口被实现或被使用时，其方式与头文件中的声明不一致，编译器就会指出错误，这一简单的规则能大大减轻程序员调试、改错的负担。

头文件的结构

头文件由两部分内容组成：
（1）预处理块。
（2）函数和类结构声明等。

【规则1】

为了防止头文件被重复引用，应当用ifndef/define/endif 结构产生预处理块。

我的理解——"ifndef"就是如果（if)没有（n)定义（def),那么就定义（define),定义完之后结束定义（endif)

假设头文件名称为 graphics.h

【规则 2】

用#include <filename.h> 格式来引用标准库的头文件（编译器将从标准库目录开始搜索）。

【规则3】

用双引号来引用非标准库的头文件，用#include “filename.h” 格式（编译器将从用户的工作目录开始搜索）。

【建议1】

头文件中只存放“声明”而不存放“定义”——建议将成员函数的定义与声明分开，不论该函数体有多么小。

【建议2】

不提倡使用全局变量，尽量不要在头文件中出现象extern int value 这类声明。

补充：extern int value是告诉编译器：在当前文件中有一个名为value的整数型变量被定义了。表明这个变量是全局变量。

虽然 extern关键字经常用于全局变量，但它也可以用于函数，表示该函数在其他地方被定义。例如，extern int add(int ,int);告诉编译器add函数在其他地方被定义，但可以在这里被调用。

#ifndef GRAPHICS_H // 防止graphics.h 被重复引用
#define GRAPHICS_H
#include <math.h> // 引用标准库的头文件
⋯
#include “myheader.h” // 引用非标准库的头文件
⋯
void Function1(⋯); // 全局函数声明
⋯
class Box // 类结构声明
{
⋯
};
#endif

定义文件的结构

定义文件有两部分内容：
（1）对一些头文件的引用。
（2）程序的实现体（包括数据和代码）。

#include “graphics.h” // 引用头文件
⋯
// 全局函数的实现体
void Function1(⋯)
{
⋯
}
// 类成员函数的实现体
void Box::Draw(⋯)
{
⋯
}

代码风格

追求清晰、美观，是程序风格的重要构成因素。也是为了增强文章的可读性。

空行

空行起着分隔程序段落的作用。空行得体（不过多也不过少）将使程序的布局更加清晰。空行不会浪费内存，虽然打印含有空行的程序是会多消耗一些纸张，但是值得。所以不要舍不得用空行。
【规则 1】在每个类声明之后、每个函数定义结束之后都要加空行。
【规则2】在一个函数体内，逻揖上密切相关的语句之间不加空行，其它地方应加空行分隔。

代码行

【规则1】一行代码只做一件事情，如只定义一个变量，或只写一条语句。这样的代码容易阅读，并且方便于写注释。
【规则2】if、for、while、do 等语句自占一行，执行语句不得紧跟其后。不论执行语句有多少都要加{}。这样可以防止书写失误。

【建议1】尽可能在定义变量的同时初始化该变量（就近原则）

int width = 10; // 定义并初绐化width
int height = 10; // 定义并初绐化height
int depth = 10; // 定义并初绐化depth

对齐

【规则1】程序的分界符‘{’和‘}’应独占一行并且位于同一列，同时与引用它们的语句左对齐。
【规则2】{ }之内的代码块在‘{’右边数格处左对齐。

长行拆分

【规则1】代码行最大长度宜控制在70 至80 个字符以内。代码行不要过长，否则眼睛看不过来，也不便于打印。

【规则2】长表达式要在低优先级操作符处拆分成新行，操作符放在新行之首（以便突出操作符）。拆分出的新行要进行适当的缩进，使排版整齐，语句可读。

修饰符的位置

修饰符 * 和＆应该靠近数据类型还是该靠近变量名，是个有争议的活题。
若将修饰符 * 靠近数据类型，例如：int* x; 从语义上讲此写法比较直观，即x是int 类型的指针。上述写法的弊端是容易引起误解，例如：int* x, y; 此处y 容易被误解为指针变量。虽然将x 和y 分行定义可以避免误解，但并不是人人都愿意这样做。
【规则1】应当将修饰符 * 和＆紧靠变量名

int *x, y; // 此处y 不会被误解为指针

注释

C++语言中，程序块的注释常采用“/*…*/”，行注释一般采用“//…”。

注释通常用于：
（1）版本、版权声明；
（2）函数接口说明；

（3）重要的代码行或段落提示。

虽然注释有助于理解代码，但注意不可过多地使用注释。
【规则1】注释是对代码的“提示”，而不是文档。程序中的注释不可喧宾夺主，注释太多了会让人眼花缭乱。注释的花样要少。
【规则2】边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。
【规则3】尽量避免在注释中使用缩写，特别是不常用缩写。
【规则4】注释的位置应与被描述的代码相邻，可以放在代码的上方或右方，不可放在下方。
【规则5】当代码比较长，特别是有多重嵌套时，应当在一些段落的结束处加注释，便于阅读。

类的版式

类可以将数据和函数封装在一起，类提供关键字public、protected 和private，分别用于声明哪些数据和函数是公有的、受保护的或者是私有的。

类的版式主要有两种方式：
（1）将private 类型的数据写在前面，而将public 类型的函数写在后面，采用这种版式的程序员主张类的设计“以数据为中心”，重点关注类的内部结构。
（2）将public 类型的函数写在前面，而将private 类型的数据写在后面，采用这种版式的程序员主张类的设计“以行为为中心”，重点关注的是类应该提供什么样的接。

书中建议读者采用“以行为为中心”的书写方式，即首先考虑类应该提供什么样的函数。这是很多人的经验——“这样做不仅让自己在设计类时思路清晰，而且方便别人阅读。因为用户最关心的是接口，谁愿意先看到一堆私有数据成员！”

读书笔记——《高质量 C++/C 编程指南》（1）

前言

文件结构

头文件的作用