华为软件编程规范.pdf

精选文库 文 档 编 号 产品版本 受控状态 DC-SB-2003-1005 V 1.0 内部 产品名称： 软件编程规范 共 页 软件编程规范 ( 仅供内部使用 ) 北京世纪百合科技有限公司 Beijing Centurial Lily Technology Co.,Ltd. 版权所有 不得复制 -- 精选文库 文档修改记录 版本号 日期 所改页 注 记 提交人 批准人 -- 精选文库 -- 精选文库 目 录 1. 引言 5 1.1 目的 5 1.2 范围 5 2. 规范 5 2.1 文件 5 2.2 版面风格 9 2.3 标识符命名 13 2.4 函数与宏 16 2.5 代码的可靠性 19 3. 附录：通用类型的公共定义 24 -- 精选文库 1. 引言 1.1 目的 本规范的目的在于增加源代码的可读性，减少程序员对代码理解上的偏差， 使程序员能够编写出可靠的代码，降低代码维护成本。 1.2 范围 本规范内容涉及范围包括：文件、版面、注释、标识符、变量和结构、函 数、宏以及可理解性等。本规范适用于公司开发的所有软件产品。在新软件的编 码过程中本规范必须执行。 2. 规范 2.1 文件 2.1.1 头文件的名称一律为小写，格式为“子系统名 _ 文件名 .h ”。例如： ipf_protocol.h 等。 2.1.2 头文件的格式如下： ? 注释头，格式参见软件编程规范； ? 头文件预编译开关开始，格式为： #ifndef 预编译开关 #define 预编译开关 其中预编译开关格式为：“ _文件名 _H ”，其中文件名一律大写 ? 头文件内容； ? 头文件预编译开关结束，格式为： #endif 用来和头文件预编译开关的开始对应。 例如：以下为 ipf_ip.h 头文件的内容： /************************************************************ Copyright (c) Lily Of The Century Technology Co., LTD. ALL RIGHTS RESERVED Description: // 用于详细说明此程序文件完成的主要功能 *************************************************************/ #ifndef _IPF_IP_H #define _IPF_IP_H ... -- 精选文库 头文件正文 ... #endif 2.1.3 头文件的定义要有层次，禁止交叉引用。 说明：头文件的层次设置为公共模块、私有模块。头文件的引用次序为下层头文件 引用上层头文件、私有头文件引用公共头