C语言编程规范 - Githubissues

1 介绍(Introduction)

1.1 为什么要有编码规范(Why Have Code Conventions) 编码规范对于程序员而言尤为重要，有以下几个原因：

一个软件的生命周期中，80%的花费在于维护
几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护
编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码
如果你将源码作为产品发布，就需要确任它是否被很好的打包并且清晰无误，一如你已构建的其它任何产品
多人协作的软件，希望大家的风格一致，就象一个人写的，看上去也比较正式 为了执行规范，每个软件开发人员必须一致遵守编码规范。

2 文件名(File Names)

这部分列出了常用的文件名及其后缀。 2.1 文件后缀(File Suffixes) Java程序使用下列文件后缀：文件类别文件后缀 c源文件 .c c++源文件 .cpp 头文件 .h 配置文件 .conf 日志 .log 2.2 常用文件名(Common File Names) 常用的文件名包括：文件名用途 makefile makefile的文件名。我们采用手工写make 或gnumake来创建（build）软件。 README 概述特定目录下所含内容的文件的首选文件名，和简短的文件功能描述

3 文件组织(File Organization)

 /*
   * Classname
   *
   * Version information
   *
   * Date
   *
   * Copyright notice
 */

4 缩进排版(Indentation)

4个空格常被作为缩进排版的一个单位。缩进的确切解释并未详细指定(空格 vs. 制表符)。一个制表符等于8个空格(而非4个)。 4.1 行长度(Line Length) 尽量避免一行的长度超过80个字符，因为很多终端和工具不能很好处理之。注意：用于文档中的例子应该使用更短的行长，长度一般不超过70个字符。 4.2 换行(Wrapping Lines) 当一个表达式无法容纳在一行内时，可以依据如下一般规则断开之：

在一个逗号后面断开
在一个操作符前面断开
宁可选择较高级别(higher-level)的断开，而非较低级别(lower-level)的断开
新的一行应该与上一行同一级别表达式的开头处对齐
如果以上规则导致你的代码混乱或者使你的代码都堆挤在右边，那就代之以缩进8个空格。以下是断开方法调用的一些例子：

  someMethod(longExpression1, longExpression2, longExpression3, 
                   longExpression4, longExpression5);

  var = someMethod1(longExpression1, 
                            someMethod2(longExpression2, 
                                               longExpression3));

if语句的换行通常使用8个空格的规则，因为常规缩进(4个空格)会使语句体看起来比较费劲。比如：

 //DON’T USE THIS INDENTATION
  if ((condition1 && condition2)
      || (condition3 && condition4)
      ||!(condition5 && condition6)) 
      { //BAD WRAPS
          doSomethingAboutIt();             //MAKE THIS LINE EASY TO MISS
      }

  //USE THIS INDENTATION INSTEAD
  if ((condition1 && condition2)
          || (condition3 && condition4)
          ||!(condition5 && condition6)) 
      {
          doSomethingAboutIt();
      }

  //OR USE THIS
  if ((condition1 && condition2) || (condition3 && condition4)
          ||!(condition5 && condition6)) 
      {
          doSomethingAboutIt();
      }

以下方法用于处理三元运算表达式：

  alpha = (aLongBooleanExpression) ? beta : gamma;

5 注释(Comments)

c程序有两类注释：实现注释(implementation comments)和文档注释(document comments)。实现注释是那些在C,C++中见过的，使用/.../和//界定的注释。文档注释(被称为"doc comments")是doxygen独有的，并由/...*/界定。文档注释可以通过dexygen工具转换成HTML文件。 1) 实现注释用以注释代码或者实现细节。文档注释从实现自由(implementation-free)的角度描述代码的规范。它可以被那些手头没有源码的开发人员读懂。有一个限定，在同一个文件里（头文件或C代码）必须只使用/*…/或//这两种方式的一种，以保持代码的清晰。最好能在整个project里只使用一种注释的方式，保持整个project代码的风格。 2) 文档注释是一种能被doxygen等工具所解析的风格，建议project里使用这样的的风格，这样完成时就能从代码里生成代码的详细文档了，就省了专门写文档的库恼了，参考doxygen的相关资料一个细节： 1）/…*/多重时，使用 #if 0 .. #endif 做注释 2）为了支持linux的编辑器vi等，所有注释使用e文，无所谓e文好不好，chinglish中国人都能看懂的

5.1 实现注释的格式(Implementation Comment Formats) 程序可以有4种实现注释的风格：块(block)、单行(single-line)、尾端(trailing)和行末(end-of-line)。 5.1.1 块注释(Block Comments) 块注释通常用于提供对文件，方法，数据结构和算法的描述。块注释被置于每个文件的开始处以及每个方法之前。它们也可以被用于其他地方，比如方法内部。在功能和方法内部的块注释应该和它们所描述的代码具有一样的缩进格式。块注释之首应该有一个空行，用于把块注释和代码分割开来，比如：

  /*
   * Here is a block comment.
  */

块注释可以以/*-开头，这样indent(1)就可以将之识别为一个代码块的开始，而不会重排它。

  /*-
    * Here is a block comment with some very special
    * formatting that I want indent(1) to ignore.
    *
    *    one
    *        two
    *            three
  */

注意：如果你不使用indent(1)，就不必在代码中使用/*-，或为他人可能对你的代码运行indent(1)作让步。参见"文档注释" 5.1.2 单行注释(Single-Line Comments) 短注释可以显示在一行内，并与其后的代码具有一样的缩进层级。如果一个注释不能在一行内写完，就该采用块注释(参见"块注释")。单行注释之前应该有一个空行。以下是一个Java代码中单行注释的例子：

  if (condition) {

    /* Handle the condition. */
    ...
  }

5.1.3 尾端注释(Trailing Comments) 极短的注释可以与它们所要描述的代码位于同一行，但是应该有足够的空白来分开代码和注释。若有多个短注释出现于大段代码中，它们应该具有相同的缩进。以下是一个c码中尾端注释的例子：

  if (a == 2) {
      return TRUE;              /* special case */
  } else {
      return isPrime(a);         /* works only for odd a */
  }

5.1.4 行末注释(End-Of-Line Comments) 注释界定符"//"，可以注释掉整行或者一行中的一部分。它一般不用于连续多行的注释文本；然而，它可以用来注释掉连续多行的代码段。以下是所有三种风格的例子：

if (foo > 1) {

      // Do a double-flip.
      ...
  }
  else {
      return false;          // Explain why here.
  }

  //if (bar > 1) {
  //
  //    // Do a triple-flip.
  //    ...
  //}
  //else {
  //    return false;
  //}

6 声明(Declarations)

6.1 每行声明变量的数量(Number Per Line) 推荐一行一个声明，因为这样以利于写注释。亦即，

 int level;  // indentation level
 int size;   // size of table

要优于， int level, size; 不要将不同类型变量的声明放在同一行，例如： int foo, fooarray[]; //WRONG!

注意：上面的例子中，在类型和标识符之间放了一个空格，另一种被允许的替代方式是使用制表符：

  int       level;         // indentation level
  int       size;          // size of table
  Object    currentEntry;  // currently selected table entry

6.2 初始化(Initialization) 尽量在声明局部变量的同时初始化。唯一不这么做的理由是变量的初始值依赖于某些先前发生的计算。 6.3 布局(Placement) 只在代码块的开始处声明变量。（一个块是指任何被包含在大括号"{"和"}"中间的代码。）不要在首次用到该变量时才声明之。这会把注意力不集中的程序员搞糊涂，同时会妨碍代码在该作用域内的可移植性。

 void myMethod() 
 {
      int int1 = 0;         // beginning of method block

      if (condition) 
      {
          int int2 = 0;     // beginning of "if" block
          ...
      }
 }

该规则的一个例外是for循环的索引变量

for (int i = 0; i < maxLoops; i++) 
{... 
}

避免声明的局部变量覆盖上一级声明的变量。例如，不要在内部代码块中声明相同的变量名：

  int count;
  ...
  myMethod() 
  {
      if (condition) 
      {
          int count = 0;     // AVOID!
          ...
      }
      ...
  }

7 语句(Statements)

7.1 简单语句(Simple Statements) 每行至多包含一条语句，例如： argv++; // Correct argc--; // Correct argv++; argc--; // AVOID!

7.2 复合语句(Compound Statements) 复合语句是包含在大括号中的语句序列，形如"{ 语句 }"。例如下面各段。

被括其中的语句应该较之复合语句缩进一个层次
左大括号"{"应位于复合语句下一行；右大括号"}"应另起一行并与复合语句首行对齐。
大括号可以被用于所有语句，包括单个语句，只要这些语句是诸如if-else或for控制结构的一部分。这样便于添加语句而无需担心由于忘了加括号而引入bug。如：

void myMethod() 
 {
      int int1 = 0;         // beginning of method block

      if (condition) 
      {
          int int2 = 0;     // beginning of "if" block
          ...
      }
  }

注：有人习惯把第一个’{‘放在复合语句行尾，project选一种，或两种都行，但每一个文件里只准用一种。 7.3 返回语句(return Statements) 一个带返回值的return语句不使用小括号"()"，除非它们以某种方式使返回值更为显见。例如：

  return;

  return myDisk.size();

  return (size ? size : defaultSize);

7.4 if，if-else，if else-if else语句(if, if-else, if else-if else Statements) if-else语句应该具有如下格式：

     if (condition) 
     {
         statements;
     }
     else 
     {
         statements;
     }

注意：if语句总是用"{"和"}"括起来，避免使用如下容易引起错误的格式：

if (condition) //AVOID! THIS OMITS THE BRACES {}!
      statement;

7.5 for语句(for Statements) 一个for语句应该具有如下格式：

for (initialization; condition; update) 
{
      statements;
}

一个空的for语句(所有工作都在初始化，条件判断，更新子句中完成）应该具有如下格式：

  for (initialization; condition; update);

当在for语句的初始化或更新子句中使用逗号时，避免因使用三个以上变量，而导致复杂度提高。若需要，可以在for循环之前(为初始化子句)或for循环末尾(为更新子句)使用单独的语句。 7.6 while语句(while Statements) 一个while语句应该具有如下格式

while (condition) 
{
      statements;
}

一个空的while语句应该具有如下格式：

while (condition);

7.7 do-while语句(do-while Statements) 一个do-while语句应该具有如下格式：

do 
{
      statements;
} while (condition);

7.8 switch语句(switch Statements) 一个switch语句应该具有如下格式：

 switch (condition) 
{
  case ABC:
      statements;
      /* falls through */
  case DEF:
      statements;
      break;

  case XYZ:
      statements;
      break;

  default:
      statements;
      break;
}

每当一个case顺着往下执行时(因为没有break语句)，通常应在break语句的位置添加注释。上面的示例代码中就包含注释/ falls through /。 7.9 try-catch语句(try-catch Statements) 一个try-catch语句应该具有如下格式：

try 
{
      statements;
} catch (ExceptionClass e) {
      statements;
}

一个try-catch语句后面也可能跟着一个finally语句，不论try代码块是否顺利执行完，它都会被执行。

try 
{
      statements;
} catch (ExceptionClass e) {
      statements;
} finally {
      statements;
}

8 空白(White Space)

funct(int a, int b);

(后无空格，,后有一空格，b后无空格还有如：

for(int I=0; I<10; I++)

for因为太长 = < ++前都无空格

int I = a + b;

= +的前后都有空格

8.1 空行(Blank Lines) 空行将逻辑相关的代码段分隔开，以提高可读性。下列情况应该总是使用两个空行：

一个源文件的两个片段 (section)之间
类声明和接口声明之间下列情况应该总是使用一个空行：
两个方法之间
方法内的局部变量和方法的第一条语句之间
块注释（参见"5.1.1"）或单行注释（参见"5.1.2"）之前
一个方法内的两个逻辑段之间，用以提高可读性

9 命名规范(Naming Conventions)

命名规范使程序更易读，从而更易于理解。它们也可以提供一些有关标识符功能的信息，以助于理解代码，例如，不论它是一个常量，包，还是类。标识符类型命名规则例子包(Packages) 一个唯一包名的前缀总是全部小写的ASCII字母并且是一个顶级域名，通常是com，edu，gov，mil，net，org，或1981年ISO 3166标准所指定的标识国家的英文双字符代码。包名的后续部分根据不同机构各自内部的命名规范而不尽相同。这类命名规范可能以特定目录名的组成来区分部门(department)，项目(project)，机器(machine)，或注册名(login names)。 com.sun.eng com.apple.quicktime.v2 edu.cmu.cs.bovik.cheese 类(Classes) 命名规则：类名是个一名词，采用大小写混合的方式，每个单词的首字母大写。尽量使你的类名简洁而富于描述。使用完整单词，避免缩写词(除非该缩写词被更广泛使用，像URL，HTML) class Raster; class ImageSprite; 接口(Interfaces) 命名规则：大小写规则与类名相似 interface RasterDelegate; interface Storing; 方法(Methods) 方法名是一个动词，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。 run(); runFast(); getBackground(); 变量(Variables) 除了变量名外，所有实例，包括类，类常量，均采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。变量名不应以下划线或美元符号开头，尽管这在语法上是允许的。变量名应简短且富于描述。变量名的选用应该易于记忆，即，能够指出其用途。尽量避免单个字符的变量名，除非是一次性的临时变量。临时变量通常被取名为i，j，k，m和n，它们一般用于整型；c，d，e，它们一般用于字符型。 char c; int i; float myWidth; 实例变量 (Instance Variables) 大小写规则和变量名相似，除了前面需要一个下划线 int _employeeId; String _name; Customer _customer; 常量(Constants) 类常量和ANSI常量的声明，应该全部大写，单词间用下划线隔开。(尽量避免ANSI常量，容易引起错误) static final int MIN_WIDTH = 4; static final int MAX_WIDTH = 999; static final int GET_THE_CPU = 1;

10 编程惯例(Programming Practices)

10.1 提供对实例以及类变量的访问控制(Providing Access to Instance and Class Variables) 若没有足够理由，不要把实例或类变量声明为公有。通常，实例变量无需显式的设置(set)和获取(gotten)，通常这作为方法调用的边缘效应 (side effect)而产生。一个具有公有实例变量的恰当例子，是类仅作为数据结构，没有行为。亦即，若你要使用一个结构(struct)而非一个类(如果java支持结构的话)，那么把类的实例变量声明为公有是合适的。 10.2 引用类变量和类方法 (Referring to Class Variables and Methods) 避免用一个对象访问一个类的静态变量和方法。应该用类名替代。例如：

  classMethod();             //OK
  AClass.classMethod();      //OK
  anObject.classMethod();    //AVOID!

10.3 常量(Constants) 位于for循环中作为计数器值的数字常量，除了-1,0和1之外，不应被直接写入代码。 10.4 变量赋值(Variable Assignments) 避免在一个语句中给多个变量赋相同的值。它很难读懂。例如：

  fooBar.fChar = barFoo.lchar = 'c'; // AVOID!

不要将赋值运算符用在容易与相等关系运算符混淆的地方。例如：

if (c++ = d++) {        // AVOID! (Java disallows)
      ...
}

应该写成

  if ((c++ = d++) != 0) {
    ...
  }

不要使用内嵌(embedded)赋值运算符试图提高运行时的效率，这是编译器的工作。例如：

  d = (a = b + c) + r;        // AVOID!

应该写成 a = b + c; d = a + r;

10.5 其它惯例(Miscellaneous Practices) 10.5.1 圆括号(Parentheses) 一般而言，在含有多种运算符的表达式中使用圆括号来避免运算符优先级问题，是个好方法。即使运算符的优先级对你而言可能很清楚，但对其他人未必如此。你不能假设别的程序员和你一样清楚运算符的优先级。

  if (a == b && c == d)     // AVOID!
  if ((a == b) && (c == d))  // RIGHT

10.5.2 返回值(Returning Values) 设法让你的程序结构符合目的。例如：

  if (booleanExpression) {
      return true;
  } else {
      return false;
  }

应该代之以如下方法： return booleanExpression;

类似地：

  if (condition) {
      return x;
  }
  return y;

应该写做： return (condition ? x : y);

10.5.3 条件运算符"?"前的表达式(Expressions before '?' in the Conditional Operator) 如果一个包含二元运算符的表达式出现在三元运算符" ? : "的"?"之前，那么应该给表达式添上一对圆括号。例如： (x >= 0) ? x : -x;

10.5.4 特殊注释(Special Comments) 在注释中使用XXX来标识某些未实现(bogus)的但可以工作(works)的内容。用FIXME来标识某些假的和错误的内容。

HMLLF / Blog

C语言编程规范 #1