程序注释说明(电子09)

《程序注释说明(电子09)》由会员上传分享，免费在线阅读，更多相关内容在应用文档-天天文库。

1、编写正确格式的程序注释说明头文件头部注释规范，注释必须列出版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等，头文件的注释中还应有函数功能简要说明： ////////////////////////////////////////////////////////////////////////////////////Copyright(C),2005-2007./// file： 文件名称WindowsNT /// briefWindowsNiceTry./// author：作者名称BillGates /// authorSeveralspe

2、ciesofsmallfurryanimalsgatheredtogether  ///         inacaveandgroovingwithapict. /// version4.0 /// date：日期   1996-1998 /// warningThisclassmayexplodeinyourface. /// warningIfyouinheritanythingfromthisclass,you'redoomed. /// FuncationList:主要函数列表，每条记录应包括函数名及功能简要说明/// 1..... /// History:

3、修改历史记录列表，每条修改记录应包括修改日期、修改者及修改内容简述///              ///     Hsz  2005/4/12    1.0    buildthismoudle   //////////////////////////////////////////////////////////////////////////////////// 源文件头部注释规范，列出：版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。示例：下面这段源文件的头注释比较标准，

4、当然，并不局限于此格式，但上述信息建议要包含在内： ////////////////////////////////////////////////////////////////////////////////////Copyright(C),2005-2007,/// file：文件 WindowsNT /// briefWindowsNiceTry. /// author：作者BillGates /// authorSeveralspeciesofsmallfurryanimalsgatheredtogether  ///         inacave

5、andgroovingwithapict. /// version4.0 /// date：日期   1996-1998 /// warningThisclassmayexplodeinyourface. /// warningIfyouinheritanythingfromthisclass,you'redoomed. /// FunctionList:主要函数列表，每条记录应包括函数名及功能简要说明/// 1..... /// History:修改历史记录列表，每条修改记录应包括修改日期、修改者及修改内容简述///         

6、ime>     ///     Hsz   2005/4/12    1.0    buildthismoudle   /////////////////////////////////////////////////////////////////////////////////    函数头部注释规范，列出：函数的目的/功能、输入参数、输出参数、返回值、调用关系（函数、表）等。示例：下面这段函数的注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内： ////////////////////////////////////

7、//////////////////////////////////////////////// fn   函数名称/// brief函数功能、性能等的描述./// param[in]参数cachar./// param[out]参数       nanint./// exception异常std::out_of_rangeparameterisoutofrange./// return返回值 acharpointer.////////////////////////////////////////////////////////////