华为软件规范笔记

华为软件规范笔记

（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:        // 修改历史记录列表&#