读书笔记之《高质量的C-C++编程》第一和第二章节：教你如何写出具有风格的代码-CSDN博客

本文链接：https://blog.csdn.net/m0_62562737/article/details/128585221

为何需要写出良好风格的代码？

在当一个人想表达“今天我要学习”的意思时，他应该就说：“今天我要学习”，而不是说“学习我要，今天”。虽然我们能够理解后面半句话的意思，但是当句子过长想要表达的意思过多时也势必会令人头晕。

而代码也是这样，在代码风格非常不好时，会令观看者非常的头晕。因此我在这里和大家分享我目前在看的《高质量的C-C++编程》这本书和一些笔记。我认为这其中的规则不一定需要刻意严格遵守，只要大体符合并让代码清晰就好。（ps：在【不遵守可能会导致错误的】地方还是遵守为好，同时在此只是简单的规则陈述，有条件的还是建议去看看书籍）

第一章文件结构

1.1 版权和版本的声明（无）

1.2 头文件的结构

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

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

【规则 1-2-3】用 #include “filename.h” 格式来引用非标准库的头文件（编译器将从用户的工作目录开始搜索）。

【建议 1-2-1】头文件中只存放“声明”而不存放“定义”

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

1.3 定义文件的结构（无）

1.4 头文件的作用（无）

1.5 目录结构（无）

第二章程序的版式

2.1 空行

【规则 2-1-1】在每个类声明之后、每个函数定义结束之后都要加空行。

【规则 2-1-2】在一个函数体内，逻揖上密切相关的语句之间不加空行，其它地方应加空行分隔。

2.2 代码行

【规则 2-2-1】一行代码只做一件事情，如只定义一个变量，或只写一条语句。这样的代码容易阅读，并且方便于写注释。

【规则 2-2-2】if、for、while、do 等语句自占一行，执行语句不得紧跟其后。不论执行语句有多少都要加{}。这样可以防止书写失误。

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

2.3 代码行内的空格

【规则 2-3-1】关键字之后要留空格。象 const、virtual、inline、case 等关键字之后至少要留一个空格，否则无法辨析关键字。象 if、for、while 等关键字之后应留一个空格再跟左括号‘（’，以突出关键字。

【规则 2-3-2】函数名之后不要留空格，紧跟左括号‘（’，以与关键字区别。

【规则 2-3-3】‘（’向后紧跟，‘）’、‘，’、‘;’向前紧跟，紧跟处不留空格。

【规则 2-3-4】‘，’之后要留空格，如 Function(x, y, z)。如果‘;’不是一行的结束符号，其后要留空格，如 for (initialization; condition; update)。

【规则 2-3-5】赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符，如“=”、“+=” “>=”、“<=”、“+”、“*”、“%”、“&&”、“||”、“<<”,“^”等二元操作符的前后应当加空格。

【规则 2-3-6】一元操作符如“!”、“~”、“++”、“--”、“&”（地址运算符）等前后不加空格。

【规则 2-3-7】像“［］”、“.”、“->”这类操作符前后不加空格。

【建议 2-3-1】对于表达式比较长的 for 语句和 if 语句，为了紧凑起见可以适当地去掉一些空格，如 for (i=0; i<10; i++)和 if ((a<=b) && (c<=d))

2.4 对齐

【规则 2-4-1】程序的分界符‘{’和‘}’应独占一行并且位于同一列，同时与引用它们的语句左对齐。

【规则 2-4-2】{ }之内的代码块在‘{’右边数格处左对齐。

2.5 长行拆分

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

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

2.6 修饰符的位置

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