华为软件规范

华为软件规范笔记

（1）关于头文件说明

¹ 2-2：对于说明性文件（如.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