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. 赋值语句多行时,逻辑运算符与上一行字符对齐

你可能感兴趣的:(Nginx编码风格图示)