代码规范化的七大原则

在C语言中不遵守编译器的规定，编译器在编译时就会报错，这个规定叫作规则。但是有一种规定，它是一种人为的、约定成俗的，这种规定就叫作规范，即使不按照那种规定也不会出错，但是那样代码写得就会很乱。

代码规范化的好处

第一个好处：看着整齐、舒服

加注释就是代码规范化的一个思想。在一般情况下，根据软件工程的思想，我们的注释要占整个文档的20%以上。所以注释要写得很详细，而且格式要写得很规范。

第二个好处：程序不容易出错

如果按照不规范的格式输入代码的话，很容易出错。而代码写规范的话即使出错了查错也会很方便。格式虽然不会影响程序的功能，但会影响可读性。程序的格式追求清晰、美观，是程序风格的重要构成元素。

代码规范化的七大原则

代码规范化基本上有七大原则，体现在空行、空格、成对书写、缩进、对齐、代码行、注释七方面的书写规范上

1、空行

空行起着分隔程序段落的作用。空行得体将使程序的布局更加清晰。空行不会浪费内存，虽

规则一：定义变量后要空行。

尽可能在定义变量的同时初始化该变量，即遵循就近原则。

如果变量的引用和定义相隔比较远，那么变量的初始化就很容易被忘记。若引用了未被初始化的变量，就会导致程序出错。

规则二：每个函数定义结束之后都要加空行。

总规则：两个相对独立的程序块、变量说明之后必须要加空行。

比如上面几行代码完成的是一个功能，下面几行代码完成的是另一个功能，那么它们中间就要加空行。这样看起来更清晰。

提倡一行一条，提高可读性

如果把多句短句写在同一行	每一句都要用分号分隔
如果把一条长句写到多行	不能将一个单词分开， 不能将双引号引起来的字符串分开

2、空格

规则一：关键字之后要留空格。

像const、case等关键字之后至少要留一个空格，否则无法辨析关键字。

像if、for、while等关键字之后应留一个空格再跟左括号“（”，以突出关键字。

规则二：函数名之后不要留空格，应紧跟左括号“（”，以与关键字区别。

规则三：“（”向后紧跟；“）”、“, ”、“; ”这三个向前紧跟；紧跟处不留空格。

规则四：“, ”之后要留空格。如果“; ”不是一行的结束符号，其后要留空格。

规则五：双目运算符的前后应当加空格

赋值运算符、关系运算符、算术运算符、逻辑运算符、位运算符，如=、==、!=、+=、-=、*=、/=、%=、＞＞=、＜＜=、&=、^=、—=、＞、＜=、＞、＞=、+、-、*、/、%、&、—、&&、——、＜＜、＞＞、^等双目运算符的前后应当加空格。

 注意，运算符“%”是求余运算符，与printf中%d的“%”不同，所以%d中的“%”前后不用加空格。

规则六：单目运算符前后不加空格。

单目运算符！、～、++、--、-、*、&等前后不加空格。

规则七：操作符前后不加空格

像数组符号“[]”、结构体成员运算符“. ”、指向结构体成员运算符“-＞”，这类操作符前后不加空格。

规则八：表达式比较长的for语句和if语句可以根据语句的长度适当地去掉一些空格

对于表达式比较长的for语句和if语句，为了紧凑起见，可以适当地去掉一些空格。但for和if后面紧跟的空格不可以删，其后面的语句可以根据语句的长度适当地去掉一些空格。

如“for (i=0; i＜10; i++)”, for和分号后面保留空格就可以了，“=”和“＜”前后的空格可去掉。

3、成对书写

成对的符号一定要成对书写，如()、{}。不要写完左括号然后写内容最后再补右括号，这样很容易漏掉右括号，尤其是写嵌套程序的时候。

4、缩进

缩进是通过键盘上的Tab键实现的，缩进可以使程序更有层次感。

原则是：如果地位相等，则不需要缩进；如果属于某一个代码的内部代码就需要缩进。

5、对齐

对齐主要是针对大括号“{}”说的：

规则一：“{”和“}”分别都要独占一行。互为一对的“{”和“}”要位于同一列，并且与引用它们的语句左对齐。

规则二：“{}”之内的代码要向内缩进一个Tab，且同一地位的要左对齐，地位不同的继续缩进。

6、代码行

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

规则二：if、else、for、while、do等语句自占一行，执行语句不得紧跟其后。此外，非常重要的一点是，不论执行语句有多少行，就算只有一行也要加“{}”，并且遵循对齐的原则，这样可以防止书写失误。

7、注释

C语言中一行注释一般采用“//…”，多行注释必须采用“/*…*/”。

注释通常用于重要的代码行或段落提示。

在一般情况下，源程序有效注释量必须在20%以上。虽然注释有助于理解代码，但注意不可过多地使用注释。

用   /*这里是注释*/  （多行注释）

和 // (单行注释)

表示注释，注意注释前后完整

 

规则一：注释是对代码的“提示”，而不是文档。程序中的注释不可喧宾夺主，注释太多会让人眼花缭乱。

规则二：如果代码本来就是清楚的，则不必加注释。

规则三：边写代码边注释，修改代码的同时要修改相应的注释，以保证注释与代码的一致性，不再有用的注释要删除。

规则四：当代码比较长，特别是有多重嵌套的时候，应当在段落的结束处加注释，这样便于阅读。

规则五：每一条宏定义的右边必须要有注释，说明其作用。

• 这里的“-”和规则五里面的“-”不同。这里的“-”是负号运算符，规则五里面的“-”是减法运算符；
• 这里的“*”和规则五里面的“*”也不同。这里的“*”是指针运算符，规则五里面的“*”是乘法运算符；
• 这里的“&”和规则五里面的“&”也不同。这里的“&”是取地址运算符，规则五里面的“&”是按位与运算符。
• 总之，规则六中的是单目运算符，而规则五中的是双目运算符，它们是不一样的。