代码规范化的七大原则

代码规范化的七大原则

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

定义变量后要空行。尽可能在定义变量的同时初始化该变量，即遵循就近原则。如果变量的引用和定义相隔比较远，那么变量的初始化就很容易被忘记。若引用了未被初始化的变量，就会导致程序出错。
每个函数定义结束之后都要加空行。
两个相对独立的程序块、变量说明之后必须要加空行。比如上面几行代码完成的是一个功能，下面几行代码完成的是另一个功能，那么它们中间就要加空行。这样看起来更清晰。

空格

关键字之后要留空格。像 const、case 等关键字之后至少要留一个空格，否则无法辨析关键字。像 if、for、while 等关键字之后应留一个空格再跟左括号(，以突出关键字。

函数名之后不要留空格，应紧跟左括号(，以与关键字区别。

(向后紧跟；)、,、;这三个向前紧跟；紧跟处不留空格。

,之后要留空格。如果;不是一行的结束符号，其后要留空格。

赋值运算符、关系运算符、算术运算符、逻辑运算符、位运算符，如 =、==、！=、+=、－=、* =、/=、%=、>>=、<<=、&=、=、|=、>、<=、>、>=、+、－、*、/、%、&、|、&&、||、<<、>>、 等双目运算符的前后应当加空格。

单目运算符 !、~、++、－－、－、*、& 等前后不加空格。

注意：
    这里的“－”和规则五里面的“－”不同。这里的“－”是负号运算符，规则五里面的“－”是减法运算符。
    这里的“ * ”和规则五里面的“ * ”也不同。这里的“ * ”是指针运算符，规则五里面的“ * ”是乘法运算符。
    这里的“&”和规则五里面的“ & ”也不同。这里的“ & ”是取地址运算符，规则五里面的“ & ”是按位与运算符。

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

对于表达式比较长的 for 语句和 if 语句，为了紧凑起见，可以适当地去掉一些空格。但 for 和 if 后面紧跟的空格不可以删，其后面的语句可以根据语句的长度适当地去掉一些空格。例如：for (i=0; i<10; i++)for 和分号后面保留空格就可以了，=和<前后的空格可去掉。

成对书写

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

缩进是通过键盘上的 Tab 键实现的，缩进可以使程序更有层次感。原则是：如果地位相等，则不需要缩进；如果属于某一个代码的内部代码就需要缩进。
对齐

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

{和}分别都要独占一行。互为一对的{和}要位于同一列，并且与引用它们的语句左对齐。
{}之内的代码要向内缩进一个 Tab，且同一地位的要左对齐，地位不同的继续缩进。

代码行

一行代码只做一件事情，如只定义一个变量，或只写一条语句。这样的代码容易阅读，并且便于写注释。
if、else、for、while、do 等语句自占一行，执行语句不得紧跟其后。此外，非常重要的一点是，不论执行语句有多少行，就算只有一行也要加{}，并且遵循对齐的原则，这样可以防止书写失误。

注释

C语言中一行注释一般采用//…，多行注释必须采用/…/。注释通常用于重要的代码行或段落提示。在一般情况下，源程序有效注释量必须在 20% 以上。虽然注释有助于理解代码，但注意不可过多地使用注释。

注释是对代码的“提示”，而不是文档。程序中的注释不可喧宾夺主，注释太多会让人眼花缭乱。
如果代码本来就是清楚的，则不必加注释。
边写代码边注释，修改代码的同时要修改相应的注释，以保证注释与代码的一致性，不再有用的注释要删除。
当代码比较长，特别是有多重嵌套的时候，应当在段落的结束处加注释，这样便于阅读。
每一条宏定义的右边必须要有注释，说明其作用。

以上七条代码规范，是无数IT界的先辈总结出来的经验教训。我们搞IT的总讲颠覆颠覆，其实吧一些原则改遵守的还是要遵守，这些都是前人总结的智慧。

其实规范就和人的形象一样，所谓站如松，坐如钟。仪表堂堂，容貌端正的人们爱看。
接下来就开始从历史上归纳了，一开始没有规范，写代码都是怎么舒服怎么来。再后来为了可维护性，总结了一些原则，比如上文所说的这些。鄙人才疏学浅，见过最早的代码规范应该是上世纪七八十年代的C语音代码规范。再后来有了微软和linux，微软公开了自己的代码规范，而linux是世界上著名的开源软件项目。大家编写代码规范都会借鉴微软和linux。