### Nginx代码风格图示 [](http://tengine.taobao.org/book/appendix_a.html#nginx-100 "永久链接至标题")
一、基本原则
> K&R编码风格(偏BSD子类)。
> 每行不能超过80列。
> 不用TAB对齐,用空格。
> 默认对齐单元是4个空格。
> 除宏定义外,字母均为小写,单词间用下划线_间隔。
> 使用C方式的注释,不得使用//形式注释。
> 中缀运算符的前后须空一格,如3 + 2以及a > 3。
> 逗号后须空一格,如foo(a, b, c);
二、风格图示
![](https://box.kancloud.cn/2015-08-12_55cb06b2afa35.JPG)
1、 if/while/for/switch语句的左花括号和关键字在同一行上,和括号之间空一个空格。
2、 else关键字和两个花括号在同一行上。
![](https://box.kancloud.cn/2015-08-12_55cb06b2b9149.png)
3、 文件开始的注释空一行。
4、 较为完整的代码块间的距离为空两行。如函数声明、函数定义之间等。
5、 函数声明或定义若一行显示不下,则函数原型空4个空格。
6、 结构体数组的花括号和内容之间空一个空格。
![](https://box.kancloud.cn/2015-08-12_55cb06b2c2d51.png)
7、 结构体数组的左花括号放在同一行上。
8、 较大的结构体数组元素最开始空一行。
9、 元素内容上下对齐。
![](https://box.kancloud.cn/2015-08-12_55cb06b2ca4ca.png)
10、注释上下对齐。
![](https://box.kancloud.cn/2015-08-12_55cb06b2d2846.png)
11、函数调用折行时,参数上下对齐。
![](https://box.kancloud.cn/2015-08-12_55cb06b2db744.png)
12、函数定义时,类型单独一行。
13、变量声明的类型上下排列按照从短到长的顺序。注意,最下面的变量的类型和名称间的空格为2-3个。一般情况下为2个,这是Nginx中最小的变量声明中类型和名称的距离。
14、变量名称上下对齐——字母对齐,不包括指针的*号。
![](https://box.kancloud.cn/2015-08-12_55cb06b2e5cf1.png)
15、结构体内变量上下对齐(字母,不包括指针的的*号)。
![](https://box.kancloud.cn/2015-08-12_55cb06b2ed906.png)
16、单行注释格式为/* something */
![](https://box.kancloud.cn/2015-08-12_55cb06b303027.png)
17、多行注释的格式为:
/*
* something
*/
![](https://box.kancloud.cn/2015-08-12_55cb06b30af2d.png)
18、函数定义的左花括号独占一行。
19、switch语句中,switch和case关键字上下对齐。
![](https://box.kancloud.cn/2015-08-12_55cb06b312839.png)
20、当条件表达式过长需要折行时,关系运算符须位于下一行的行首,并与上一行的条件表达式的第一个字符对齐,同时右花括号须位于单独的一行,并与if/while等关键字对齐。
![](https://box.kancloud.cn/2015-08-12_55cb06b31bbef.png)
21、 else语句之前须空出一行。
![](https://box.kancloud.cn/2015-08-12_55cb06b3276ed.png)
22、在函数中,相同类型的变量声明放在一行上。
- 上篇:nginx模块开发篇
- nginx平台初探
- 初探nginx架构
- nginx基础概念
- connection
- request
- keepalive
- pipe
- lingering_close
- 基本数据结构
- ngx_str_t
- ngx_pool_t
- ngx_array_t
- ngx_hash_t
- ngx_hash_wildcard_t
- ngx_hash_combined_t
- ngx_hash_keys_arrays_t
- ngx_chain_t
- ngx_buf_t
- ngx_list_t
- ngx_queue_t
- nginx的配置系统
- 指令参数
- 指令上下文
- nginx的模块化体系结构
- 模块的分类
- nginx的请求处理
- handler模块
- handler模块简介
- 模块的基本结构
- 模块配置结构
- 模块配置指令
- 模块上下文结构
- 模块的定义
- handler模块的基本结构
- handler模块的挂载
- handler的编写步骤
- 示例: hello handler 模块
- handler模块的编译和使用
- 更多handler模块示例分析
- http access module
- http static module
- http log module
- 过滤模块
- 过滤模块简介
- 过滤模块的分析
- upstream模块
- upstream模块
- upstream模块接口
- memcached模块分析
- 本节回顾
- 负载均衡模块
- 配置
- 指令
- 钩子
- 初始化配置
- 初始化请求
- peer.get和peer.free回调函数
- 本节回顾
- 其他模块
- core模块
- event模块
- 模块开发高级篇
- 变量
- 下篇:nginx原理解析篇
- nginx架构详解
- nginx的源码目录结构
- nginx的configure原理
- 模块编译顺序
- nginx基础设施
- 内存池
- nginx的启动阶段
- 概述
- 共有流程
- 配置解析
- nginx的请求处理阶段
- 接收请求流程
- http请求格式简介
- 请求头读取
- 解析请求行
- 解析请求头
- 请求体读取
- 读取请求体
- 丢弃请求体
- 多阶段处理请求
- 多阶段执行链
- POST_READ阶段
- SERVER_REWRITE阶段
- FIND_CONFIG阶段
- REWRITE阶段
- POST_REWRITE阶段
- PREACCESS阶段
- ACCESS阶段
- POST_ACCESS阶段
- TRY_FILES阶段
- CONTENT阶段
- LOG阶段
- Nginx filter
- header filter分析
- body filter分析
- ngx_http_copy_filter_module分析
- ngx_http_write_filter_module分析
- subrequest原理解析
- https请求处理解析
- 附录A 编码风格
- 附录B 常用API
- 附录C 模块编译,调试与测试