Nginx 附录A 编码风格 和 附录B 常用API

Nginx 附录A 编码风格 (100%)

 

Nginx代码风格图示 (100%)

一、基本原则

K&R编码风格(偏BSD子类)。

每行不能超过80列。

不用TAB对齐,用空格。

默认对齐单元是4个空格。

除宏定义外,字母均为小写,单词间用下划线_间隔。

使用C方式的注释,不得使用//形式注释。

中缀运算符的前后须空一格,如3 + 2以及a > 3。

逗号后须空一格,如foo(a, b, c);

二、风格图示

http://tengine.taobao.org/book/_images/code-style-1.JPG

1、 if/while/for/switch语句的左花括号和关键字在同一行上,和括号之间空一个空格。

2、 else关键字和两个花括号在同一行上。

http://tengine.taobao.org/book/_images/code-style-2.JPG

3、 文件开始的注释空一行。

4、 较为完整的代码块间的距离为空两行。如函数声明、函数定义之间等。

5、 函数声明或定义若一行显示不下,则函数原型空4个空格。

6、 结构体数组的花括号和内容之间空一个空格。

http://tengine.taobao.org/book/_images/code-style-3.JPG

7、 结构体数组的左花括号放在同一行上。

8、 较大的结构体数组元素最开始空一行。

9、 元素内容上下对齐。

http://tengine.taobao.org/book/_images/code-style-4.JPG

10、注释上下对齐。

http://tengine.taobao.org/book/_images/code-style-5.JPG

11、函数调用折行时,参数上下对齐。

http://tengine.taobao.org/book/_images/code-style-6.JPG

12、函数定义时,类型单独一行。

13、变量声明的类型上下排列按照从短到长的顺序。注意,最下面的变量的类型和名称间的空格为2-3个。一般情况下为2个,这是Nginx中最小的变量声明中类型和名称的距离。

14、变量名称上下对齐——字母对齐,不包括指针的*号。

http://tengine.taobao.org/book/_images/code-style-7.JPG

15、结构体内变量上下对齐(字母,不包括指针的的*号)。

http://tengine.taobao.org/book/_images/code-style-8.JPG

16、单行注释格式为/* something */

http://tengine.taobao.org/book/_images/code-style-9.JPG

17、多行注释的格式为:

/*
 * something
 */

http://tengine.taobao.org/book/_images/code-style-10.JPG

18、函数定义的左花括号独占一行。

19、switch语句中,switch和case关键字上下对齐。

http://tengine.taobao.org/book/_images/code-style-11.JPG

20、当条件表达式过长需要折行时,关系运算符须位于下一行的行首,并与上一行的条件表达式的第一个字符对齐,同时右花括号须位于单独的一行,并与if/while等关键字对齐。

http://tengine.taobao.org/book/_images/code-style-12.JPG

21、 else语句之前须空出一行。

http://tengine.taobao.org/book/_images/code-style-13.JPG

22、在函数中,相同类型的变量声明放在一行上。

 

 

附录B 常用API

B.1 字符串操作

B.2 读取请求体

B.3 操作请求头

B.4 取参数

B.5 URI处理

B.6 buffer操作

B.7 变量操作

B.8 日志输出

B.9 配置解析接口

B.10 文件操作

B.11 锁操作

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值