1 源文件头部注释 Ø 列出:版权、作者、编写日期和描述。 Ø 示例: [cpp] view plain copy print? 01./************************************************* 02.Copyright:bupt 03.Author: 04.Date:2010-08-25 05.Description:描述主要实现的功能 06.**************************************************/ 2 函数头部注释 /功能、输入参数、输出参数、返回值、调用关系(函数、表)等。 Ø 示例:下面这段函数的注释比较标准,当然,并不局限于此格式,但上述信息建议 要包含在内。 [cpp] view plain copy print? 01./************************************************* 02.Function: // 函数名称 03.Description: // 函数功能、性能等的描述 04.Calls: // 被本函数调用的函数清单 05.Table Accessed: // 被访问的表(此项仅对于牵扯到数据库操作的程序) 06.Table Updated: // 被修改的表(此项仅对于牵扯到数据库操作的程序) 07.Input: // 输入参数说明,包括每个参数的作 08. // 用、取值说明及参数间关系。 09.Output: // 对输出参数的说明。 10.Return: // 函数返回值的说明 11.Others: // 其它说明 12.*************************************************/