注释方法，读《华为编程规范和范例》笔记

说明性文件（如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等）头部应

进行注释，注释必须列出：版权说明、版本号、生成日期、作者、内容、功能、与其它文件的

关系、修改日志等，头文件的注释中还应有函数功能简要说明。

 

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

 Copyright (C), 1988-1999, Huawei Tech. Co., Ltd.

 File name: // 文件名

 Author: Version: Date: // 作者、版本及完成日期

 Description: // 用于详细说明此程序文件完成的主要功能，与其他模块

              // 或函数的接口，输出值、取值范围、含义及参数间的控

              // 制、顺序、独立或依赖等关系

 Others: // 其它内容的说明

 Function List: // 主要函数列表，每条记录应包括函数名及功能简要说明

 1. ....

 History: // 修改历史记录列表，每条修改记录应包括修改日期、修改

          // 者及修改内容简述

 1. Date:

 Author:

 Modification:

 2. ...

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

 

 

源文件头部应进行注释，列出：版权说明、版本号、生成日期、作者、模块目的/功能、

主要函数及其功能、修改日志等。

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

 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 是修改历史记录列表，每条修改记录应包括修改日期、修改

者及修改内容简述。

 

 

函数头部应进行注释，列出：函数的目的/功能、输入参数、输出参数、返回值、调用

关系（函数、表）等。

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

 Function: // 函数名称

 Description: // 函数功能、性能等的描述

 Calls: // 被本函数调用的函数清单

 Called By: // 调用本函数的函数清单

 Table Accessed: // 被访问的表（此项仅对于牵扯到数据库操作的程序）

 Table Updated:  // 被修改的表（此项仅对于牵扯到数据库操作的程序）

 Input: // 输入参数说明，包括每个参数的作

        // 用、取值说明及参数间关系。

 Output: // 对输出参数的说明。

 Return: // 函数返回值的说明

 Others: // 其它说明

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

其他 注释要求

12-1：一般情况下，源程序有效注释量必须在20％以上。

说明：注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不

能太少，注释语言必须准确、易懂、简洁。

12-5：边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有

用的注释要删除。

12-6：注释的内容要清楚、明了，含义准确，防止注释二义性。

说明：错误的注释不但无益反而有害。

规则2-7：避免在注释中使用缩写，特别是非常用缩写。

说明：在使用缩写时或之前，应对缩写进行必要的说明。

12-8：注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释）

相邻位置，不可放在下面，如放于上方则需与其上面的代码用空行隔开。

12-9：对于所有有物理含义的变量、常量，如果其命名不是充分自注释的，在声明时都必须加

以注释，说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。

12-10：数据结构声明(包括数组、结构、类、枚举等)，如果其命名不是充分自注释的，必须

加以注释。对数据结构的注释应放在其上方相邻位置，不可放在下面；对结构中的每个域的注

释放在此域的右方。

12-11：全局变量要有较详细的注释，包括对其功能、取值范围、哪些函数或过程存取它以及

存取时注意事项等的说明。