附录 A 编码风格 (100%)
Nginx代码风格图示 (100%)
一、基本原则
K&R编码风格(偏BSD子类)。
每行不能超过80列。
不用TAB对齐,用空格。
默认对齐单元是4个空格。
除宏定义外,字母均为小写,单词间用下划线_间隔。
使用C方式的注释,不得使用//形式注释。
中缀运算符的前后须空一格,如3 + 2以及a > 3。
逗号后须空一格,如foo(a, b, c);
二、风格图示
![https://www.xnip.cn/wp-content/uploads/2021/docimg18/10-bxd5302p0dv.jpg](https://imgs.xnip.cn/cj/docimg/121/7cd92f1a-96ab-4f98-8d0e-3a8b93fc7276.jpg)
1、 if/while/for/switch语句的左花括号和关键字在同一行上,和括号之间空一个空格。
2、 else关键字和两个花括号在同一行上。
![https://www.xnip.cn/wp-content/uploads/2021/docimg18/11-44umxwkltwa.jpg](https://imgs.xnip.cn/cj/docimg/121/d7f3a9c0-c323-42da-85fe-3e88bb063c95.jpg)
3、 文件开始的注释空一行。
4、 较为完整的代码块间的距离为空两行。如函数声明、函数定义之间等。
5、 函数声明或定义若一行显示不下,则函数原型空4个空格。
6、 结构体数组的花括号和内容之间空一个空格。
![https://www.xnip.cn/wp-content/uploads/2021/docimg18/12-sfhi2sc2i2h.jpg](https://imgs.xnip.cn/cj/docimg/121/8883ebb5-de2d-4b0b-a458-3aa25c47115e.jpg)
7、 结构体数组的左花括号放在同一行上。
8、 较大的结构体数组元素最开始空一行。
9、 元素内容上下对齐。
![https://www.xnip.cn/wp-content/uploads/2021/docimg18/13-sfbwwk4fx40.jpg](https://imgs.xnip.cn/cj/docimg/121/30161550-0c06-4ea8-b4dc-7edbb638a65e.jpg)
10、注释上下对齐。
![https://www.xnip.cn/wp-content/uploads/2021/docimg18/14-mgpv5qfussc.jpg](https://imgs.xnip.cn/cj/docimg/121/bac4706b-62a3-448b-bc9d-bb7a19fc5643.jpg)
11、函数调用折行时,参数上下对齐。
![https://www.xnip.cn/wp-content/uploads/2021/docimg18/15-43ioeiao2r4.jpg](https://imgs.xnip.cn/cj/docimg/121/fb9a6086-a893-4798-aef3-0aeb7702f314.jpg)
12、函数定义时,类型单独一行。
13、变量声明的类型上下排列按照从短到长的顺序。注意,最下面的变量的类型和名称间的空格为2-3个。一般情况下为2个,这是Nginx中最小的变量声明中类型和名称的距离。
14、变量名称上下对齐——字母对齐,不包括指针的*号。
![https://www.xnip.cn/wp-content/uploads/2021/docimg18/16-ei5lwc2lora.jpg](https://imgs.xnip.cn/cj/docimg/121/4b8b8be4-b729-46c5-8b5e-6d8529d76e5d.jpg)
15、结构体内变量上下对齐(字母,不包括指针的的*号)。
![https://www.xnip.cn/wp-content/uploads/2021/docimg18/17-50wzt1hp1ut.jpg](https://imgs.xnip.cn/cj/docimg/121/fb37764d-61cd-456f-9343-5c99034a2885.jpg)
16、单行注释格式为/* something */
![https://www.xnip.cn/wp-content/uploads/2021/docimg18/18-jlp2kufckgv.jpg](https://imgs.xnip.cn/cj/docimg/121/64743288-7937-40b5-a1eb-af21923faf96.jpg)
17、多行注释的格式为:
/* * something */
![https://www.xnip.cn/wp-content/uploads/2021/docimg18/19-1dfkxhjljrt.jpg](https://imgs.xnip.cn/cj/docimg/121/08860c09-4510-4d48-ae53-fe290f644949.jpg)
18、函数定义的左花括号独占一行。
19、switch语句中,switch和case关键字上下对齐。
![https://www.xnip.cn/wp-content/uploads/2021/docimg18/20-x3lbise15mr.jpg](https://imgs.xnip.cn/cj/docimg/121/b3eba9fe-47fe-4f2a-baf4-caefeff95df5.jpg)
20、当条件表达式过长需要折行时,关系运算符须位于下一行的行首,并与上一行的条件表达式的第一个字符对齐,同时右花括号须位于单独的一行,并与if/while等关键字对齐。
![https://www.xnip.cn/wp-content/uploads/2021/docimg18/21-kl3uhmhexsp.jpg](https://imgs.xnip.cn/cj/docimg/121/3d7a7406-3935-422b-9de5-e227f5fb5c33.jpg)
21、 else语句之前须空出一行。
![https://www.xnip.cn/wp-content/uploads/2021/docimg18/22-ufujo02zors.jpg](https://imgs.xnip.cn/cj/docimg/121/5c06e461-c0db-4380-b3d8-1f0566eb817b.jpg)
22、在函数中,相同类型的变量声明放在一行上。