C核心技术手册（四）

1.1 注释

在源码中应该使用注释来说明程序，在C语言中，有两种插入注释的方法：块注释使用“/*”表示 开始，“*/”表示结束；行注释使用“//”开始，直到此行结尾。

你可以使用分割符/*和*/在一行中开始和结束注释，并可以嵌套注释在多行中，例如，在下面的函数原型中，省略号(…)表示open()函数有第三个可选参数，注释解释此参数的使用方法:

int open( const char *name, int mode, ... /* int permissions */ );

你可以使用//来插入完整的一行注释，或者将代码和注释写于一行中，代码位于左，注释位于右边：

const double pi = 3.1415926536;     // Pi is constant

行注释方法在C99中才被正式纳入标准，但绝大多数编译器在c99之前就已经支持此类注释方法，尽管这种注释方法起源于C的前身BCPL语言中，但有时还会被称做C++风格的注释。

在引号中，分割符表示一个字符常量或字符串常量，在这种场景下，/*和//并不是开始一个注释，例如，下面的语句不包含注释：

printf( "Comments in C begin with /* or //./n" );

预处理器检查最后一个分割符来判断注释结束与否，所以不能在一注释中再嵌套一个块注释，但你可以在一个块注释中添加行注释。

/* Temporarily removing two lines:
const double pi = 3.1415926536;     // Pi is constant
area = pi * r * r                   // Calculate the area
Temporarily removed up to here */

如果想注释一段包含块注释的代码，你可以使用条件预处理语句。

 #if 0
    const double pi = 3.1415926536;     /* Pi is constant     */
    area = pi * r * r                   /* Calculate the area */
  #endif