【朝花夕拾】C语言-空白与注释

 从严格意义上来说，C语言并没有如Python那样严格的缩进限制，所以你可以很自由的编写你的代码。但是，那样会导致你的代码可读性非常差，当你的程序出现了BUG，想要调试的时候，你会发现自己都不知道自己写的是什么了。因此一个良好的编码习惯显得尤为重要，不为了别人，就为了我们自己能够很好的DEBUG，我们也应该养成一个良好的编码习惯。

一、合理的使用注释

注释分为行注释和块注释，所有的注释都会被预处理器拿掉，取而代之的是一个空格。因此注释可以出现在任何空格可以出现的地方[01]。

// 这是一个行注释，顾名思义即注释掉一行，在双斜杠后面的所有内容将会被注释。

/*

 * 这是一个块注释，顾名思义就是在两个斜杠星之间的东西将会被注释掉

 * 使用块注释需要注意，一般不要对块注释进行嵌套，很容易出问题

*/

还有一个在调试的时候比较常用的注释

#if 0

在这之间的所有内容将被注释，如需打开注释只需要将#if 0改为# if 1

#endif

对于一个变量的意义，或者一个代码块的功能，我们就需要使用注释，比如一个比较复杂的函数的功能

二、合理的使用空行和空格

如果你想体验一下比较奇葩的编码风格，不对完全没有风格，你可以百度一下C混乱代码大赛（international Obfuscated C Code Contest），看一下其中参赛的作品，也许你会直观的体会到，良好的编码风格对于可读性有多么大的影响

由于不同的书籍，或者不同的公司会有不同的编码规范，所以下面我就列举下C和指针中建议的风格：

1、空行用于分隔不同的逻辑代码段，他们是按照功能分段的。这样，读者一眼就可以看到某个逻辑代码段的结束，而不是仔细阅读每行代码来找到它。

2、if和相关语句的括号是这些语句的一部分，而不是它们测试表达式的一部分。所以，在括号和表达式之间留下一个空格，使表达式看上去更突出一些。函数原型也是如此。

3、在绝大多数操作符的使用中，中间都隔以空格，这可以使表达式的可读性更佳。有时，在复杂的表达式中，会省略空格，着有助于显示子表达式的分组。

4、潜逃语其他语句中的语句将缩进，以显示他们之间的层次，使用Tab键而不是空格，你可以很容易的将相关联的语句整齐的排列。当整页都是代码的时候，使用足够大的缩进有助于程序匹配得到正确的定位，只使用两三个空格是不够用的。

5、绝大部分注释都是成块出现的，这样他们在视觉上在代码中很突出。我们可以更容易的找到并跳过他们。

最后还有一句话，使用什么风格不重要，重要的是选择一种风格并始终如一的使用它。