软件编程规范总则 2注释 /大大大大大大大大大大大大大大大大大大★大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大 Copyright (C),1988-1999, Huawei Tech. Co., Ltd. FileName: test. cpp Author Description 模块描述 Version 版本信息 Function List://主要函数及其功能 History /历史修改记录 <author> <time> <version <desc> David 96/10/12 build this moudle 大★大大大大大★★大★★大★大大★大大大大大大大大★★大大大大★大大大大大★★大大★大大大大★大大大大大★大大大★★大 说明: Description一项描述本文件的内容、功能、内部各部分之间的关系及本文件与 其它文件关系等。 History是修改历史记录列表,每条修改记录应包括修改日期、修改 者及修改内容简述 2-4:函数头部应进行注释,列出:函数的目的/功能、输入参数、输出参数、返回值、调用 关系(函数、表)等 示例:下面这段函数的注释比较标准,当然,并不局限于此格式,但上述信息建议要包含 在内 /*大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大大 Function /函数名称 Description ∥/函数功能、性能等的描述 Calls /被本函数调用的函数清单 Called By /调用本函数的函数清单 Table Accessed://被访问的表(此项仅对于牵扯到数据库操作的程序) Table Updated://被修改的表(此项仅对于牵扯到数据库操作的程序) Input: /输入参数说明,包括每个参数的作 /用、取值说明及参数间关系。 Output //对输出参数的说明 /函数返回值的说明 /其它说明 大★大大大大★大大大大★大大大大大大大大大大大大大大大大大大大大★大★大大大大大大大/ 仅供内部使用10软件编程规范总则 2 注释 仅供内部使用 10 /************************************************************ Copyright (C), 1988-1999, Huawei Tech. Co., Ltd. FileName: test.cpp Author: Version : Date: Description: // 模块描述 Version: // 版本信息 Function List: // 主要函数及其功能 1. ------- History: // 历史修改记录 <author> <time> <version > <desc> David 96/10/12 1.0 build this moudle ***********************************************************/ 说明：Description 一项描述本文件的内容、功能、内部各部分之间的关系及本文件与 其它文件关系等。History 是修改历史记录列表，每条修改记录应包括修改日期、修改 者及修改内容简述。 ¹2-4：函数头部应进行注释，列出：函数的目的/功能、输入参数、输出参数、返回值、调用 关系（函数、表）等。 示例：下面这段函数的注释比较标准，当然，并不局限于此格式，但上述信息建议要包含 在内。 /************************************************* Function: // 函数名称 Description: // 函数功能、性能等的描述 Calls: // 被本函数调用的函数清单 Called By: // 调用本函数的函数清单 Table Accessed: // 被访问的表（此项仅对于牵扯到数据库操作的程序） Table Updated: // 被修改的表（此项仅对于牵扯到数据库操作的程序） Input: // 输入参数说明，包括每个参数的作 // 用、取值说明及参数间关系。 Output: // 对输出参数的说明。 Return: // 函数返回值的说明 Others: // 其它说明 *************************************************/