华为技术有限公司c语言编程规范.pdf
《华为技术有限公司c语言编程规范.pdf》由会员分享,可在线阅读,更多相关《华为技术有限公司c语言编程规范.pdf(61页珍藏版)》请在三一文库上搜索。
1、DKBA 华为技术有限公司内部技术规范 DKBA 2826-2011.5 C语言编程规范 2011年5月9日发布 2011年 5月9日实施 华为技术有限公司 Huawei Technologies Co., Ltd. 版权所有侵权必究 All rights reserved 密级: confidentiality level DKBA 2826-2011.5 2011-06-02 华为机密,未经许可不得扩散Huawei Confidential 第2页,共61页Page 2 , Total61 修订声明 Revision declaration 本规范拟制与解释部门: 本规范的相关系列规范或文
2、件: 相关国际规范或文件一致性: 替代或作废的其它规范或文件: 相关规范或文件的相互关系: 规范号主要起草部门专家主要评审部门专家修订情况 DKBAxxxx.x-xxxx.xx PSST 质量部: 郭曙光 00121837 网络: 张伟 00118807 周灿 00056781 王晶 00041937 陈艺彪 00036913 IP开发部: 薛治 00038309 核心网: 张小林 00058208 王德喜 00040674 李明胜 00042021 软件公司: 文滔00119601 无线: 刘爱华 00162172 中研: 谭洪 00162654 PSST 质量部: 李重霄 00117374
3、 郭永生 00120218 核心网: 张进柏 00120359 中研: 张建保 00116237 无线: 苏光牛 00118740 郑铭 00118617 陶永祥 00120482 软件公司: 周代兵 00120359 刘心红 00118478 朱文琦 00172539 网络: 王玎 00168059 黄维东 49827 IP开发部: 饶远 00152313 密级: confidentiality level DKBA 2826-2011.5 2011-06-02 华为机密,未经许可不得扩散Huawei Confidential 第3页,共61页Page 3 , Total61 目录Table
4、 of Contents 0 规范制订说明 5 0.1前言 5 0.2代码总体原则 . 5 0.3规范实施、解释 6 0.4术语定义 . 6 1 头文件 . 6 2 函数 . 12 3 标识符命名与定义. 21 3.1通用命名规则 . 21 3.2文件命名规则 . 23 3.3变量命名规则 . 23 3.4函数命名规则 . 24 3.5宏的命名规则 . 24 4 变量 . 25 5 宏、常量 28 6 质量保证 32 7 程序效率 36 8 注释 . 39 9 排版与格式 44 10表达式 . 46 11代码编辑、编译 49 12可测性 . 50 13安全性 . 51 13.1字符串操作安全
5、51 13.2整数安全 . 52 13.3格式化输出安全 56 13.4文件 I/O安全 57 13.5其它 59 14单元测试 . 59 15可移植性 . 60 16业界编程规范 60 密级: confidentiality level DKBA 2826-2011.5 2011-06-02 华为机密,未经许可不得扩散Huawei Confidential 第4页,共61页Page 4 , Total61 C语言编程规范 范围: 本规范适用于公司内使用C语言编码的所有软件。本规范自发布之日起生效,以后新编写的和修改的 代码应遵守本规范。 简介: 本规范制定了编写C语言程序的基本原则、规则和建
6、议。从代码的清晰、简洁、可测试、安全、程序效 率、可移植各个方面对C语言编程作出了具体指导。 密级: confidentiality level DKBA 2826-2011.5 2011-06-02 华为机密,未经许可不得扩散Huawei Confidential 第5页,共61页Page 5 , Total61 0规范制订说明 0.1 前言 为提高产品代码质量,指导广大软件开发人员编写出简洁、可维护、可靠、可测试、高效、可移植的 代码,编程规范修订工作组分析、总结了我司的各种典型编码问题,并参考了业界编程规范近年来的 成果,重新对我司1999年版编程规范进行了梳理、优化、刷新,编写了本规范
7、。 本规范将分为完整版和精简版,完整版将包括更多的样例、规范的解释以及参考材料(what 这个头文件不但定义了基本数据类型WORD,还包含了 stdio.h syslib.h等等不常用的头文件。如果工 程中有 10000个源文件, 而其中 100个源文件使用了stdio.h的printf, 由于上述头文件的职责过于庞大, 而WORD又是每一个文件必须包含的,从而导致stdio.h/syslib.h等可能被不必要的展开了9900次,大 大增加了工程的编译时间。 原则 1.3 头文件应向稳定的方向包含。 说明:头文件的包含关系是一种依赖,一般来说,应当让不稳定的模块依赖稳定的模块,从而当不稳 定的
8、模块发生变化时,不会影响(编译)稳定的模块。 就我们的产品来说,依赖的方向应该是:产品依赖于平台,平台依赖于标准库。某产品线平台的代码 中已经包含了产品的头文件,导致平台无法单独编译、发布和测试,是一个非常糟糕的反例。 除了不稳定的模块依赖于稳定的模块外,更好的方式是两个模块共同依赖于接口,这样任何一个模块 的内部实现更改都不需要重新编译另外一个模块。在这里,我们假设接口本身是最稳定的。 延伸阅读材料:编者推荐开发人员使用“ 依赖倒置 ” 原则,即由使用者制定接口,服务提供者实现接口, 更具体的描述可以参见敏捷软件开发:原则、模式与实践(Robert C.Martin 著 邓辉译 清 华大学出
9、版社 2003 年9月)的第二部分 “ 敏捷设计 ” 章节。 规则 1.1 每一个 .c 文件应有一个同名.h 文件,用于声明需要对外公开的接口。 说明:如果一个.c 文件不需要对外公布任何接口,则其就不应当存在,除非它是程序的入口,如main 函数所在的文件。 现有某些产品中,习惯一个.c 文件对应两个头文件,一个用于存放对外公开的接口,一个用于存放内 部需要用到的定义、声明等,以控制.c 文件的代码行数。编者不提倡这种风格。这种风格的根源在于 源文件过大,应首先考虑拆分.c 文件,使之不至于太大。另外,一旦把私有定义、声明放到独立的头 文件中,就无法从技术上避免别人include之,难以保
10、证这些定义最后真的只是私有的。 本规则反过来并不一定成立。有些特别简单的头文件,如命令 ID定义头文件, 不需要有对应的.c 存在。 示例:对于如下场景,如在一个.c 中存在函数调用关系: void foo() bar(); void bar() Do something; 必须在 foo 之前声明 bar ,否则会导致编译错误。 这一类的函数声明,应当在.c 的头部声明,并声明为static的,如下: staticvoid bar(); void foo() bar(); 密级: confidentiality level DKBA 2826-2011.5 2011-06-02 华为机密,未
11、经许可不得扩散Huawei Confidential 第9页,共61页Page 9 , Total61 void bar() Do something; 规则 1.2 禁止头文件循环依赖。 说明:头文件循环依赖,指a.h 包含 b.h ,b.h 包含 c.h , c.h 包含 a.h 之类导致任何一个头文件修改,都 导致所有包含了a.h/b.h/c.h的代码全部重新编译一遍。而如果是单向依赖,如a.h 包含 b.h , b.h 包含 c.h ,而 c.h 不包含任何头文件,则修改a.h 不会导致包含了b.h/c.h的源代码重新编译。 规则 1.3 .c/.h文件禁止包含用不到的头文件。 说明:
12、很多系统中头文件包含关系复杂,开发人员为了省事起见,可能不会去一一钻研,直接包含一 切想到的头文件,甚至有些产品干脆发布了一个god.h ,其中包含了所有头文件,然后发布给各个项目 组使用,这种只图一时省事的做法,导致整个系统的编译时间进一步恶化,并对后来人的维护造成了 巨大的麻烦。 规则 1.4 头文件应当自包含。 说明:简单的说,自包含就是任意一个头文件均可独立编译。如果一个文件包含某个头文件,还要包 含另外一个头文件才能工作的话,就会增加交流障碍,给这个头文件的用户增添不必要的负担。 示例: 如果 a.h 不是自包含的,需要包含b.h 才能编译,会带来的危害: 每个使用 a.h 头文件的
13、 .c 文件,为了让引入的a.h 的内容编译通过,都要包含额外的头文件b.h 。 额外的头文件b.h 必须在 a.h 之前进行包含,这在包含顺序上产生了依赖。 注意:该规则需要与“.c/.h文件禁止包含用不到的头文件”规则一起使用,不能为了让a.h 自包含, 而在 a.h 中包含不必要的头文件。a.h 要刚刚可以自包含,不能在 a.h 中多包含任何满足自包含之外的其 他头文件。 规则 1.5 总是编写内部#include保护符( #define 保护)。 说明:多次包含一个头文件可以通过认真的设计来避免。如果不能做到这一点,就需要采取阻止头文 件内容被包含多于一次的机制。 通常的手段是为每个文
14、件配置一个宏,当头文件第一次被包含时就定义这个宏,并在头文件被再次包 含时使用它以排除文件内容。 所有头文件都应当使用#define 防止头文件被多重包含,命名格式为FILENAME_H ,为了保证唯一性, 更好的命名是PROJECTNAME_PATH_FILENAME_H。 注:没有在宏最前面加上“ _“ ,即使用 FILENAME_H 代替 _FILENAME_H_ ,是因为一般以“_“ 和” _“ 开头的 标识符为系统保留或者标准库使用,在有些静态检查工具中,若全局可见的标识符以“_“ 开头会给出告 警。 定义包含保护符时,应该遵守如下规则: 1)保护符使用唯一名称; 2)不要在受保护部
15、分的前后放置代码或者注释。 密级: confidentiality level DKBA 2826-2011.5 2011-06-02 华为机密,未经许可不得扩散Huawei Confidential 第10页,共61页Page 10 , Total61 示例:假定 VOS 工程的 timer 模块的 timer.h, 其目录为 VOS/include/timer/timer.h,应按如下方式保护: #ifndef VOS_INCLUDE_TIMER_TIMER_H #define VOS_INCLUDE_TIMER_TIMER_H . #endif 也可以使用如下简单方式保护: #ifnde
16、f TIMER_H #define TIMER_H #endif 例外情况:头文件的版权声明部分以及头文件的整体注释部分(如阐述此头文件的开发背景、使用注 意事项等)可以放在保护符(#ifndef XX_H)前面。 规则 1.6 禁止在头文件中定义变量。 说明:在头文件中定义变量,将会由于头文件被其他.c 文件包含而导致变量重复定义。 规则 1.7 只能通过包含头文件的方式使用其他.c 提供的接口,禁止在.c 中通过 extern 的方式使用外部 函数接口、变量。 说明:若 a.c 使用了 b.c 定义的 foo() 函数,则应当在b.h 中声明 extern int foo(int inpu
17、t);并在 a.c 中通过 #include 来使用 foo 。禁止通过在a.c 中直接写 extern int foo(int input);来使用 foo , 后面这种写法容易在foo 改变时可能导致声明和定义不一致。 规则 1.8 禁止在 extern “C“中包含头文件。 说明:在 extern “C“中包含头文件,会导致extern “C“嵌套, Visual Studio对extern “C“嵌套层次有 限制,嵌套层次太多会编译错误。 在extern “C“中包含头文件,可能会导致被包含头文件的原有意图遭到破坏。例如,存在a.h 和b.h 两 个头文件: #ifndef A_H_
18、#define A_H_ #ifdef _cplusplus void foo( int ); #define a(value) foo(value) #else void a( int ) #endif #endif/* A_H_ */ #ifndef B_H_ #define B_H_ #ifdef _cplusplus extern“C“ #endif #include“a.h“ void b(); #ifdef _cplusplus #endif #endif/* B_H_ */ 使用 C+ 预处理器展开b.h ,将会得到 密级: confidentiality level DKBA
19、2826-2011.5 2011-06-02 华为机密,未经许可不得扩散Huawei Confidential 第11页,共61页Page 11 , Total61 extern“C“ void foo(int ); void b(); 按照 a.h 作者的本意,函数foo 是一个 C+ 自由函数,其链接规范为“C+“ 。但在 b.h 中,由于 #include “a.h“ 被放到了 extern “C“ 的内部,函数foo 的链接规范被不正确地更改了。 示例:错误的使用方式: extern “ C ” #include“ xxx.h ” . 正确的使用方式: #include“ xxx.h
20、” extern “ C ” . 建议 1.1 一个模块通常包含多个.c 文件,建议放在同一个目录下,目录名即为模块名。为方便外部使 用者,建议每一个模块提供一个.h ,文件名为目录名。 说明:需要注意的是,这个.h 并不是简单的包含所有内部的.h ,它是为了模块使用者的方便,对外整 体提供的模块接口。 以Google test (简称 GTest)为例, GTest作为一个整体对外提供C+单元测试框架,其1.5 版本的 gtest 工程下有 6个源文件和 12个头文件。但是它对外只提供一个gtest.h,只要包含 gtest.h即可使用 GTest 提供的所有对外提供的功能,使用者不必关系G
21、Test内部各个文件的关系,即使以后GTest 的内部实现 改变了,比如把一个源文件c拆成两个源文件,使用者也不必关心,甚至如果对外功能不变,连重新编 译都不需要。 对于有些模块, 其内部功能相对松散,可能并不一定需要提供这个.h , 而是直接提供各个子模块或者.c 的头文件。 比如产品普遍使用的VOS ,作为一个大模块,其内部有很多子模块,他们之间的关系相对比较松散,就 不适合提供一个vos.h 。而 VOS 的子模块,如Memory(仅作举例说明,与实际情况可能有所出入),其 内部实现高度内聚,虽然其内部实现可能有多个.c 和.h ,但是对外只需要提供一个Memory.h声明接口。 建议
22、1.2 如果一个模块包含多个子模块,则建议每一个子模块提供一个对外的.h ,文件名为子模块名。 说明:降低接口使用者的编写难度。 建议 1.3 头文件不要使用非习惯用法的扩展名,如.inc。 说明: 目前很多产品中使用了.inc作为头文件扩展名,这不符合 c语言的习惯用法。在使用 .inc 作为头 文件扩展名的产品,习惯上用于标识此头文件为私有头文件。但是从产品的实际代码来看,这一条并 没有被遵守,一个.inc 文件被多个 .c 包含比比皆是。本规范不提倡将私有定义单独放在头文件中,具 密级: confidentiality level DKBA 2826-2011.5 2011-06-02
23、华为机密,未经许可不得扩散Huawei Confidential 第12页,共61页Page 12 , Total61 体见规则 1.1 。 除此之外,使用.inc 还导致 source insight、Visual stduio等IDE工具无法识别其为头文件,导致很 多功能不可用,如“跳转到变量定义处”。虽然可以通过配置,强迫IDE识别 .inc 为头文件,但是有些 软件无法配置,如Visual Assist只能识别 .h 而无法通过配置识别.inc。 建议 1.4 同一产品统一包含头文件排列方式。 说明:常见的包含头文件排列方式:功能块排序、文件名升序、稳定度排序。 示例 1: 以升序方式
24、排列头文件可以避免头文件被重复包含,如: #include #include #include #include #include 示例 2: 以稳定度排序,建议将不稳定的头文件放在前面,如把产品的头文件放在平台的头文件前面,如下: #include #include 相对来说, product.h修改的较为频繁,如果有错误,不必编译platform.h就可以发现 product.h的错 误,可以部分减少编译时间。 2函数 背景 函数设计的精髓:编写整洁函数,同时把代码有效组织起来。 整洁函数要求:代码简单直接、不隐藏设计者的意图、用干净利落的抽象和直截了当的控制语句将函 数有机组织起来。 代
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 华为 技术有限公司 语言 编程 规范
链接地址:https://www.31doc.com/p-5518573.html