【C/C++高质量代码】------第一章，程序的版式

怎么写出有质量的代码呢？
作为软件开发人员，除了把代码正确的打出来，还需要对程序的正确性，健壮性，可靠性，效率，易用性，可读性，可扩展性，可复用性，兼容性和可移植性了如指掌且运用自如。跟随Yena，将理论用于实际，写出让人眼前一亮的优质代码吧~推荐书籍：高质量C/C++编程指南

---

前言

程序版式会影响程序的可读性，程序的版式应追求清晰，美观。好的代码令人一目了然，心情愉悦，而可读性差的代码自己都很难看懂，很难去维护。那么，我们一起来美化自己的程序吧~

---

1. 空行的规则

空行起着分割程序段落的作用，将程序模块化，布局清晰。空行不会浪费内存，可以放心使用。

1. 类声明之后，每个函数定义之后，都要加空行,实例如下

void Fun1()
{
	...
}
//空行
void Fun2()
{
	...
}

2. 在一个函数体内，若代码很长，逻辑密切相关的语句之间不加空行，其他地方要加空行分割。示例如下

while(1)
{
	int a = 1;
	//空行
	if (condition)
	{
		...;
	}
	else
	{
		...;
	}
	//空行
	int b = 2;	
}

2.代码行

1. 一行代码只做一个事情，如只定义一个变量，只写一条语句。这样的代码方便阅读和注释。实例如下

int year;         
int month;   
int day;

if (condition)
{
	dosomething;
}

2. 尽可能在定义变量的同时，进行初始化。以防引用未初始化的变量导致程序错误。示例如下

int year = 0;
int month = 0;
int day = 0;

3.代码内的空格

1. 关键字之后要留空格，if , for ,while 等关键字之后，留一个空格再写（，以突出关键字。示例如下

if (condition)  //留空格
for (int i=1; i<=n; i++)

2. 函数名之后不接空格，紧跟（，以区分函数名和关键字，示例如下

void Fun(int i, int j)//Fun 与（之间不留空格
{
	...
}

3."（ " 紧跟后面的内容，" ）" 紧跟前面的内容，不要留空格。
4. " , " ," ; " 紧跟前面的内容，不留空格二元操作符
5.== 二元操作符==，例如" >= " , " <= “, " += “, " && " ,” * " ,” << " ," ^ " 的前后应该有空格。示例如下

if (a >= b)
{
	sum = a * b;
	c = a % b;
}

6. 一元操作符例如" ! " ," ++ " ," & " ," ~ " ，前后不加空格。示例如下

int *x = &y;
if (*x != NULL)
{
	n++;
}

7. 例如" [] " ," . " , " -> " ,之类操作符前后不加空格。示例如下

int arr[10] = {0};
a.Function1();
b->Funtion2();

4. 对齐

1. 程序模块分界符" { " ," } "应独占一行并且位于同一列，与引用它们的语句左对齐，示例如下

if (condition)
{
	...
}
else
{
	...
}
void Fun()
{
	...
}
//错误示范
if (condition){
	...
}

5. 长行拆分

1. 代码行最大长度应控制在70至80个字符之内，代码行不应过长，否则影响可读性
2. 长表达式可在低优先级操作符处拆分成新行，操作符放在中新行之首，以突出操作符。加以适当缩进，是板式美观整齐。示例如下

if ((veryvery_longer_variable1 >= veryvery_longer_variable2)
    && (veryvery_longer_variable3 >= veryvery_longer_variable4)
    && (veryvery_longer_variable4 >= veryvery_longer_variable5))
{
	...
}

6. 修饰符的位置

修饰符" * " ," & " ,应靠近数据类型还是变量名呢
靠近数据类型

int* x , 这样的写法直观，表示 x 是指向整型变量的指针。
但这样写有一个弊端，会引起误会。
例如
int*	x, y;
这里 y 是整型，但容易被误解成 y 也是指针

靠近变量名

int	*x, y;
这里就能避免 y 被误解

7. 注释

注释通常用于

1. 版本版权声明
2. 函数接口声明
3. 重要代码行或段落提

C语言注释符为"\* *\"
C++中，程序块的注释采用"\* *\ " , 行注释 一般采用" // "

7.1 注释规则

1. 注释是对代码的提示，而不是文档，要求言简意赅
2. 若代码本身足够清晰，则不必加注释，多此一举
3. 边写代码边注释，在修改代码的同时，把注释也修改，保证注释与代码一致
4. 注释一定要准确，错误的注释害处很大
5. 在注释中尽量避免缩写，尤其是不常见的缩写
6. 注释的位置应与被注释位置相邻，可以放在代码上方或右方，不能放在下方
7. 在代码比较长时，可在其末尾处加注释，方便阅读。

8. 类的板式

类的板式主要有两种方式

1. private 类型数据写在前面，public 类型的函数写在后面，以数据为中心，教科书通常采用这种方式
2. 将public类型的函数写在前面，private 类型数据写在后面，以行为为中心，关注类提供的服务。

建议第二种板式，首先考虑需要实现哪些功能，这样设计，使自己思路清晰，也方便别人阅读。并且，用户更关心接口，而不是一堆私有成员。

---

总结

本篇文章讲的是如何给程序排版，使程序看起来美观，整洁。将理论用于实践吧~如若期待下一章的话，就关注一下波(^▽)