LINUX C代码风格

  C语言代码缩进规则

1.关键字与其后的控制表达式的括号之间插入一个空格分隔，但括号内的表达式应紧贴括号。

    while (1)

2.双目运算符的两侧各插入一个空格分隔，单目运算符和操作数之间不加空格。

3.后缀运算符和操作数之间也不加空格，例如取结构体成员s.a、函数调用foo(arg1)、取数组成员a[i]。

4.,号和;号之后要加空格，这是英文的书写习惯。

    for (i = 0; i < 100; i++)

5.以上关于双目运算符和后缀运算符的规则并没有严格要求，有时候为了突出优先级也可以写得更紧凑一些,但是省略的空格一定不要误导了读代码的人。

6.由于UNIX系统标准的字符终端是24行80列的，接近或大于80个字符的较长语句要折行写，折行后用空格和上面的表达式或参数对齐。

    if (sqrt(x * x + y * y) > 5.0
       && x < 0.0
       && y > 0.0)

7.较长的字符串可以断成多个字符串然后分行书写，C编译器会自动把相邻的多个字符串接在一起。

    printf("This is such a long sentence"
           "that it cannot be held within"
           "a line\n");

8.有的人喜欢在变量定义语句中用Tab字符，使变量名对齐，这样看起来很美观。

    int    a, b;
    double c;

  内核代码风格缩进规则

1.用缩进体现出语句块的层次关系，使用Tab字符缩进，不能用空格代替Tab。在标准的字符终端上一个Tab看起来是8个空格的宽度，如果你的文本编辑器可以设置Tab的显示宽度是几个空格，建议也设成8，这样大的缩进使代码看起来非常清晰。如果有的行用空格做缩进，有的行用Tab做缩进，甚至空格和Tab混用，那么一旦改变了文本编辑器的Tab显示宽度就会看起来非常混乱，所以内核代码风格规定只能用Tab做缩进，不能用空格代替Tab。

2.if/else、while、do/while、for、switch这些可以带语句块的语句，语句块的{或}应该和关键字写在同一行，用空格隔开，而不是单独占一行，好处是不必占太多行，使得一屏能显示更多代码。

    if (...) {
       Do something
    } else if (...) {
       Do something
    }

3.函数定义的{和}单独占一行，这一点和语句块的规定不同。

    int foo(int a, int b)
    {
      Do something
    }

4.switch和语句块里的case、default对齐写，也就是说语句块里的case、default标号相对于switch不往里缩进，但标号下的语句要往里缩进。

    switch (c) {
    case 'A':
             Do something
    case 'B':
             Do something
    default:
             Do something
    }

5.代码中每个逻辑段落之间应该用一个空行分隔开。例如每个函数定义之间应该插入一个空行，头文件、全局变量定义和函数定义之间也应该插入空行。

    #include <stdio.h>
    #include <stdlib.h>

    int    g;
    double h;

    int foo(void)
    {
      Do something
    }

    int bar(int a)
    {
      Do something
    }

    int main(void)
    {
      Do something
    }

6.一个函数的语句列表如果很长，也可以根据相关性分成若干组，用空行分隔。这条规定不是严格要求，通常把变量定义组成一组，后面加行，return语句之前加空行。

    int main(void)
    {
      int      a, b;
      double   c;

      Do something

      Do something else

      return 0;
    }

  C语言注释规则

1.单行注释应采用/* comment */的形式，用空格把界定符和文字分开，多行注释最常见的是这种形式：

    /*
     * Multi-line
     * comment
     */

2.整个源文件的顶部注释，说明此模块的相关信息，例如文件名、作者和版本历史等，顶头写不缩进。

3.函数注释，说明此函数的功能、参数、返回值、错误码等，写在函数定义上侧，和此函数定义之间不留空行，顶头写不缩进。

4.相对独立的语句组注释，对这一组语句做特别说明，写在语句组上侧，和此语句组之间不留空行，与当前语句组的缩进一致。

5.代码行右侧的简短注释。对当前代码行做特别说明，一般为单行注释，和代码之间至少用一个空格隔开，一个源文件中所有的右侧注释最好能上下对齐。

6.函数内的注释要尽可能少用，写注释主要是为了说明你的代码“能做什么”（比如函数接口定义），而不是为了说明“怎样做”，只要代码写得足够清晰，“怎样做”是一目了然的，如果你需要用注释才能解释清楚，那就表示你的代码可读性很差，除非是特别需要提醒注意的地方才使用函数内注释。

7.复杂的结构体定义比函数更需要注释。8.复杂的宏定义和变量声明也需要注释。


  C语言标识符命名规则

1.标识符命名要清晰明了，可以使用完整的单词和易于理解的缩写。短的单词可以通过去元音形成缩写，较长的单词可以取单词的头几个字母形成缩写。看别人的代码看多了就可以总结出一些缩写惯例，例如count写成cnt，block写成blk，length写成len，window写成win，message写成msg，number写成nr，temporary可以写成temp，也可以进一步写成tmp，最有意思的是internationalization写成i18n，词根trans经常缩写成x，例如transmit写成xmt。

2.内核编码风格规定变量、函数和类型采用全小写加下划线的方式命名，常量（比如宏定义和枚举常量）采用全大写加下划线的方式命名，比如函数名radix_tree_insert、类型名struct radix_tree_root、常量名RADIX_TREE_MAP_SHIFT等。微软发明了一种变量命名法叫匈牙利命名法，在变量名中用前缀表示类型，例如iCnt（i表示int）、pMsg（p表示pointer）、lpszText（lpsz表示long pointer to a zero-ended string）等。内核编码风格不要使用大小写混合的变量命名方式更不要使用匈牙利命名法。

3.全局变量和全局函数的命名一定要详细，不惜多用几个单词多写几个下划线，例如函数名radix_tree_insert，因为它们在整个项目的许多源文件中都会用到，必须让使用者明确这个变量或函数是干什么用的。局部变量和只在一个源文件中调用的内部函数的命名可以简略一些，但不能太短。尽量不要使用单个字母做变量名，只有一个例外：用i、j、k做循环变量是可以的。

4.针对中国程序员的一条特别规定：禁止用汉语拼音做标识符，可读性极差。

  C语言函数编写规则

1.实现一个函数只是为了做好一件事情，不要把函数设计成用途广泛、面面俱到的，这样的函数肯定会超长，而且往往不可重用，维护困难。

2.函数内部的缩进层次不宜过多，一般以少于4层为宜。如果缩进层次太多就说明设计得太复杂了，应考虑分割成更小的函数来调用。

3.函数不要写得太长，建议在24行的标准终端上不超过两屏，太长会造成阅读困难，如果一个函数超过两屏就应该考虑分割函数了。如果一个函数在概念上是简单的，只是长度很长，这倒没关系。例如函数由一个大的switch组成，其中有非常多的case，这是可以的，因为各case分支互不影响，整个函数的复杂度只等于其中一个case的复杂度，这种情况很常见，例如TCP协议的状态机实现。

4.执行函数就是执行一个动作，函数名通常应包含动词，例如get_current、radix_tree_insert。

5.比较重要的函数定义上侧必须加注释，说明此函数的功能、参数、返回值、错误码等。

6.另一种度量函数复杂度的办法是看有多少个局部变量，5到10个局部变量已经很多了，再多就很难维护了，应该考虑分割成多个函数。