注释说明

/************************************************************************/
/*    Function Name        :    demoForFunction commentary
 *    Create Date          :    2011/07/25
 *    Author/Corporation   :    YangKai/HQU
 *    
 *    Description          :    This is a demo for function commentary.
 *                              It's a new line for your description continue.
 *
 *    Param                :    Make a description for params in function
 *
 *    Return value         :    Make a description for return value in function
 *
 *    Global Variable      :    ..........
 *
 *    File Static Variable :    ..........
 *
 *    Function Static Variable : ..........
 *-------------------------------------------
 *    Revision History
 *    No.      Date          Revised by    Item      Description
 *    V0.5     2011/0724     YangKai       .....      .........
/************************************************************************/

1.在源文件头部进行必要的源程序的总体注释：版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等，头文件的注释中还应有函数功能简要说明。

2.在函数的头部进行必要的函数注释：函数的目的/功能、输入参数、输出参数、返回值、调用关系(函数、表)等。

3.其他的少量注释。如全局变量的功能、取值范围等。千万不要陈述那些一目了然的内容，否则会使注释的效果适得其反。