编码风格

转自: 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://i-blog.csdnimg.cn/blog_migrate/15e9a37a0eb752c0655c90c2b377bd60.jpeg

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

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

https://i-blog.csdnimg.cn/blog_migrate/689a21e98f200ad0eb82caeb9f299556.jpeg

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

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

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

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

https://i-blog.csdnimg.cn/blog_migrate/e74256bf5574dc9e6af819826bbc8e7a.jpeg

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

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

9、 元素内容上下对齐。

https://i-blog.csdnimg.cn/blog_migrate/4ddd4a600dde183829670b52ade78148.jpeg

10、注释上下对齐。

https://i-blog.csdnimg.cn/blog_migrate/62ff5c3ef8c073824dc84794ea42c8a7.jpeg

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

https://i-blog.csdnimg.cn/blog_migrate/0e5ab6bc472f11461406f13085d1bbdd.jpeg

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

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

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

https://i-blog.csdnimg.cn/blog_migrate/2521223c721ea72b4f7e2cb50f5ff964.jpeg

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

https://i-blog.csdnimg.cn/blog_migrate/b8cc4c45f72a03226f68f4af895d93a1.jpeg

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

https://i-blog.csdnimg.cn/blog_migrate/22023d6845cc402d1d9a02acc0241fc4.jpeg

17、多行注释的格式为:

/*
 * something
 */
https://i-blog.csdnimg.cn/blog_migrate/2e8fae6408b9b07facd04e7b09405500.jpeg

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

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

https://i-blog.csdnimg.cn/blog_migrate/0edea535f948b154ed7f33e58a35395b.jpeg

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

https://i-blog.csdnimg.cn/blog_migrate/8705b688257f2d4d16658a42306ae996.jpeg

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

https://i-blog.csdnimg.cn/blog_migrate/fad1e36eb70695357779d4cd5d3a2952.jpeg

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


  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值