程序中的注释

最近有很多展示自己程序的场合，因此比较注重注释的书写。一来给大家留个好影响，主要的还是便于阅读。

  1. 文件开始注释内容包括：单位名称、版权、作者、时间、模块用途、背景介绍等。

  2.  函数注释包括：输入、输出、函数描述、流程处理、全局变量、调用样例等，复杂的函数需要加上变量用途说明。

  3. 程序中注释包括：修改时间和作者、方便理解的注释等;。

引用一:   文件开头的注释模板

/******************************************************************

**   文件名:

**   Copyright   (c)   2011-2012   所在单位 

**   创建人:

**   创建日期:

**   修改人:

**   修改日期:

**   描   述:

**

**   版   本:

**--------------------------------------------------------------------------

 


   ******************************************************************/


    引用二:   函数开头的注释模板

/*****************************************************************

 **   函数名:

**   输   入:   

**   输   出:   x---

**   x   为   1,   表示...

**   x   为   0,   表示...

**   功能描述:

**   全局变量:

**   调用模块:

**   作   者:

**   创建日期:

**   修   改:

**   修改日期:

**   版本

****************************************************************/

引用三:   程序中的注释模板

/*----------------------------------------------------------*/

/*   注释内容   */

/*----------------------------------------------------------*/