Nginx编码风格图示

特别声明:本文是在《Nginx开发从入门到精通》的附录A 编码风格基础上补充完善了一些细节问题。

一、基本原则

  • K&R编码风格(偏BSD子类)
  • 每行不能超过80列
  • 不用TAB对齐,用空格
  • 默认对齐单元是4个空格
  • 除宏定义外,字母均为小写,单词间用下划线间隔
  • 使用C方式的注释,不得使用//形式注释
  • 中缀运算符的前后须空一格,如3 + 2以及a > 3
  • 逗号后须空一格,如foo(a, b, c);
  • if/while/for/switch条件表达式只有一行时,左花括号与表达式处于同一行,表达式为多行时,左花括号独占一行

二、风格图示(if/while/for/switch)

  1. 小括号与两边字符空一个空格,括号内表达式两边与括号之间没有空格
  2. 如果表达式只有一行,if/while/for/switch语句的左花括号和关键字在同一行上,和括号之间空一个空格
  3. else/else if语句之前须空出一行
  4. else/else if关键字和两个花括号在同一行上,且左右空一个空格
  5. 右花括号与if/while/for/switch关键字对齐




  6. 当条件表达式过长需要折行时,逻辑运算符须位于下一行的行首,并与同一层次的条件表达式的第一个字符对齐
  7. 当条件表达式过长需要折行时,比较运算符须位于下一行的行首,并与比较语句的第一个字符对齐
  8. 当条件表达式为多行时,左花括号须位于单独的一行,并与if/while等关键字对齐


  9. 例外情况,当条件表达式过长时,逻辑运算符可以适当提前


  10. 例外情况,条件表达式一行刚好80字符,左花括号可以位于单独一行


  11. switch语句中,switch和case关键字上下对齐


  12. for语句表达式分多行时,分成三行,且每行第一个字符对齐


  13. 无限循环语句使用for ( ;; ),分号两边都空一格空格

三、风格图示(函数)

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


  2. 函数定义时,返回类型及修饰符独占一行
  3. 函数参数列表过长需要换行时,换行后需要空4个空格
  4. 函数定义的左花括号独占一行


  5. 函数调用折行时,参数上下对齐

四、风格图示(变量、结构体)

  1. 在函数中,相同类型的变量声明放在一行上
  2. 函数中变量声明的类型上下排列按照从短到长的顺序。注意,最下面的变量的类型和名称间的空格为2-3个。一般情况下为2个,这是Nginx中最小的变量声明中类型和名称的距离
  3. 变量名称上下对齐——字母对齐,不包括指针的*号


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


  5. 结构体数组的左花括号放在同一行上
  6. 结构体数组的花括号和内容之间空一个空格


  7. 较大的结构体数组元素最开始空一行,元素之间也空一行
  8. 元素内容上下对齐

五、风格图示(其他)

  1. 文件开始的注释空一行
  2. 较为完整的代码块间的距离为空两行。如函数声明、函数定义之间等
  3. 函数中不同处理逻辑之间可以空一行


  4. 注释上下对齐


  5. 单行注释格式为/* something */
  6. 多行注释的格式为:
/*
 * something
 */
  1. 字符串赋值语句多行时引号对齐


  2. 赋值语句多行时,逻辑运算符与上一行字符对齐
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,236评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,867评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,715评论 0 340
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,899评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,895评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,733评论 1 283
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,085评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,722评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,025评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,696评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,816评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,447评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,057评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,009评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,254评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,204评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,561评论 2 343

推荐阅读更多精彩内容