C代码风格（规范）

左手的ㄟ右手 2023-03-05 03:15 215阅读 0赞

# 前言 #

团队开发的时候，为了便于交流一个团队内有个通用的代码风格，能提高组员之间的交流效率，便于互相帮助。而制定一套C代码风格牵涉的细节较多，但是大多数规范要求相差并不大。因此可以参考别的公司的代码风格规范，制定一套关于自己团队的文档，文档尽量考虑目前团队的代码风格做出修改即可，尽量与之前的代码风格保持一致。

# 代码格式规范化的七大原则 #

代码格式规范化基本上有七大原则，体现在空行、空格、成对书写、缩进、对齐、代码行、注释七方面的书写规范上，**遵循这些规则可以使代码更整洁且便于阅读**。不过这只是格式的要求，具体要求请看**参考文献1**。

## 1) 空行 ##

空行起着分隔程序段落的作用。空行得体将使程序的布局更加清晰。空行不会浪费内存，虽然打印含有空行的程序会多消耗一些纸张，但是值得。

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

## 2) 空格 ##

*  规则一：关键字之后要留空格。像 const、case 等关键字之后至少要留一个空格，否则无法辨析关键字。像 if、for、while 等关键字之后应留一个空格再跟左括号(，以突出关键字。
 *  规则二：函数名之后不要留空格，应紧跟左括号(，以与关键字区别。
 *  规则三：(向后紧跟；)、,、;这三个向前紧跟；紧跟处不留空格。
 *  规则四：,之后要留空格。如果;不是一行的结束符号，其后要留空格。
 *  规则五：赋值运算符、关系运算符、算术运算符、逻辑运算符、位运算符，如 =、==、！=、+=、－=、\*=、/=、%=、>>=、<<=、&=、=、|=、>、<=、>、>=、+、－、\*、/、%、&、|、&&、||、<<、>>、 等双目运算符的前后应当加空格。

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

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

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

总之，规则六中的是单目运算符，而规则五中的是双目运算符，它们是不一样的。

*  规则七：像数组符号\[\]、结构体成员运算符.、指向结构体成员运算符->，这类操作符前后不加空格。
 *  规则八：对于表达式比较长的 for 语句和 if 语句，为了紧凑起见，可以适当地去掉一些空格。但 for 和 if 后面紧跟的空格不可以删，其后面的语句可以根据语句的长度适当地去掉一些空格。例如：  
    `for (i=0; i<10; i++)`

> for 和分号后面保留空格就可以了，=和<前后的空格可去掉。

## 3) 成对书写 ##

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

## 4) 缩进 ##

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

## 5) 对齐 ##

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

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

## 6) 代码行 ##

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

## 7) 注释 ##

C语言中一行注释一般采用//…，多行注释必须采用/*…*/。注释通常用于重要的代码行或段落提示。虽然注释有助于理解代码，但注意不可过多地使用注释，尽量通过函数命名，使函数做的事情能清晰呈现出来，以减少注释量。

*  规则一：注释是对代码的“提示”，而不是文档。程序中的注释不可喧宾夺主，注释太多会让人眼花缭乱。
 *  规则二：如果代码本来就是清楚的，则不必加注释。例如：

i++;  //i加1

这个就是多余的注释。

*  规则三：边写代码边注释，修改代码的同时要修改相应的注释，以保证注释与代码的一致性，不再有用的注释要删除。
 *  规则四：当代码比较长，特别是有多重嵌套的时候，应当在段落的结束处加注释，这样便于阅读, 能拆分的情况下拆分优先，拆分不开再考虑增加注释。
 *  规则五：宏定义的右边要有注释说明其作用，如果宏名含义已足够清晰，则可不用注释。

可参考文章：

1.  [C语言编程规范][C]
2.  [Google C++ Style Guide][Google C_ Style Guide]
3.  [C语言代码规范（编程规范）][C 1]
4.  [C语言规范–参考阿里C语言规范][C_C]

[C]: https://ilcc.gitbooks.io/wiki/content/StyleGuide/Huawei-C/index.html
[Google C_ Style Guide]: https://ilcc.gitbooks.io/wiki/content/StyleGuide/Google-Cpp-en/google-cpp-styleguide.html
[C 1]: http://c.biancheng.net/view/158.html
[C_C]: https://blog.csdn.net/qq_28877125/article/details/85769485