华为C语言通用编程规范.docx





《华为C语言通用编程规范.docx》由会员分享,可在线阅读,更多相关《华为C语言通用编程规范.docx(64页珍藏版)》请在淘文阁 - 分享文档赚钱的网站上搜索。
1、章节内容0前言目的重点关注约定例外1原则好代码的原则类和函数设计指导原则保证静态类型安全遵循C+ ISO标准优先编译时检查错误使用命名空间来限定作用域优先使用C+特性而不是C特性2命名通用命名文件命名函数命名类型命名变量命名宏、常量、枚举命名3格式行宽缩进大括号函数声明和定义函数调用if语句循环语句switch语句表达式变量赋值初始化指针和引用编译预处理空格和空行类4注释注释风格文件头注释函数头注释代码注释5头文件头文件职责头文件依赖6作用域命名空间全局函数和静态成员函数全局变量全局常量和静态成员常量7类构造、拷贝构造、赋值和析构函数继承多重继承重载8函数函数设计内联函数函数参数9 C+其常量
2、与初始化表达式类型转换资源分配和释放标准库const的用法异常他特性模板宏10现代代码简洁性和安全性提升智能指针Lambda接口C+特性。前言目的规则并不是完美的,通过禁止在特定情况下有用的特性,可能会对代码实现造成影响。但是我们制定规则的目的为了大多数程序员可以得到更多的好处如果在团队运作中认为某个规则无法遵循,希望可以共同改进该规则。参考该规范之前,希望您具有相应的C+基础能力,而不是通过该文档来学习C+。1.了解C+的ISO标准;2.熟知C+的基本语言特性,包括C+03/11/14/17相关特性;3.了解C+的标准库;重点关注1 约定C+的编程风格,比如命名,排版等。2 C+的模块化设计
3、,如何设计头文件,类,接口和函数。3 C+相关特性的优秀实践,比如常量,类型转换,资源管理,模板等。4 现代C+的优秀实践,包括C+11/14/17中可以提高代码可维护性,提高代码可靠性的相关约定。约定规则:编程时必须遵守的约定(must)建议:编程时应该遵守的约定(should)本规范适用通用C+标准,如果没有特定的标准版本,适用所有的版本(C+03/11/14/17),例外无论是规则还是建议,都必须理解该条目这么规定的原因,并努力遵守。但是,有些规则和建议可能会有例外。在不违背总体原则,经过充分考虑,有充足的理由的前提下,可以适当违背规范中约定。例外破坏了代码的一致性,请尽量避免。规则的例
4、外应该是极少的。下列情况,应风格一致性原则优先:修改外部开源代码、第三方代码时,应该遵守开源代码、第三方代码已有规范,口持风格结一某些特定M域:优先参考其行业规范。1原则好代码的原则我们参考Kent Beck的简单设计四原则来指导我们的如何写出优秀的代码,如何有效地判断我们的代码是优秀的。1.通过所有测试(Passes its tests)2.尽可能消除重复(Minimizes duplication)3.尽可能清晰表达(Maximizes clarity)4.更少代码元素(Has fewer elements)5.以上四个原则的重要程度依次降低。这组定义被称做简单设计原则。第一条强调的是外部
5、需求,这是代码实现最重要的;第二点就是代码的模块架构设计,保证代码的正交性,保证代码更容易修改;第三点是代码的可阅读性,保证代码是容易阅读的;最后一点才是保证代码是简洁的,在简洁和表达力之间,我们更看重表达力。类和函数设计指导原则C+是典型的面向对象编程语言,软件工程界已经有很多OOP原则来指导我们编写大规模的,高可扩展的,可维护性的代码:-高内聚,低耦合的基本原则- SOLID原则-迪米特法则-Tell, Don,task原则-组合/聚合复用原则保证静态类型安全我们希望C+应该是静态类型安全的,这样可以减少运行时的错误,提高代码的健壮性。但是由于C+的下面的特性存在,会破坏C+静态类型安全,
6、我们针对这部分特性要仔细处理。unions联合体类型转换cast -缩窄转换narrowing conversions -类型退化type decay -范围错误range errors-void*类型指针我们可以通过约束这些特性的使用,或者使用C+的新特性,比如variant(C+17), GSL的span, narrow_cast等来解决这些问题,提高C+代码的健壮性。遵循C+ISO标准希望通过使用ISO C+标准的特性来编写C+代码,对于ISO标准中未定义的或者编译器实现的特性要谨慎使用,对于GCC等编译器的提供的扩展特性也需要谨慎使用,这些特性会导致代码的可移植性比较差。注意:如果模块
7、中需要使用相关的扩展特性来,那么尽可能将这些特性封装成独立的接口,并且可以通过编译选项关闭或者编译这些特性。对于这些扩展特性的使用,请模块制定特性编程指南来指导这些特性的使用。优先编译时检查错误通过编译器来优先保证代码健壮性,而不是通过编写错误处理代码来处理编译就可以发现的异常,比如: 通过const来保证数据的不变性,防止数据被无意修改。 通过gsl:span等来保证char数组不越界,而不是通过运行时的length检查。 通过static_assert来进行编译时检查。使用命名空间来限定作用域全局变量,全局常量和全局类型定义由于都属于全局作用域,在项目中,使用第三方库中容易出现冲突。命名空
8、间将作用域细分为独立的,具名的作用域,可有效地防止全局作用域的命名冲突。1. class, struct等都具有自己的类作用域。2.具名的namespace可以实现类作用域更上层的作用域。3.匿名namespace和static可以实现文件作用域。对于没有作用域的宏变量,宏函数强烈建议不使用。作用域的一些缺点:1.虽然可以通过作用域来区分两个命名相同的类型,但是还是具有迷惑性。2.内联命名空间会让命名空间内部的成员摆脱限制,让人迷惑。3.通过多重嵌套来定义namespace,会让完整的命名空间比较冗长。所以,我们使用命名空间的建议如下:-对于变量,常量和类型定义尽可能使用 namespace,
9、减少全局作用域的冲突-不要在头文件中使用using namespace -不要使用内联命名空间-鼓励在.cpp文件中通过匿名namespace或者static集封装,防止不必要的定义通过API暴露出去。优先使用C+特性而不是C特性C+比起c语言更加类型安全,更加抽象。我们更推荐使用C+的语言特性来编程,比如使用string而不是char*,使用vector而不是原生数组,使用namespace而不是 static o通用命名常见命名风格有:驼峰风格(CamelCase)大小写字母混用,单词连在一起,不同单词间通过单词首字母大写来分开。按连接后的首字母是否大写,又分:大驼峰(UperCamelC
10、ase)和小驼峰(lowerCamelCase)内核风格(unixike)单词全小写,用下划线分割如:test_result匈牙利风格在大驼峰的基础上,加上前缀;前缀用于表达类型或用途。如:iSavedCount,Tested,规则2.1.1标识符命名使用驼峰风格命名风格大驼峰大驼峰(接口部分可加 前缀,如XXX一函数 名)小驼峰k+大小写混合 大写+下划线 全小写不考虑匈牙利命名,在内核风格与驼峰风格之间,根据存量代码的情况,我们选择驼峰风格。类型类类型,结构体类型,枚举类型,联合体类型等类型定义函数(包括全局函数,作用域函数,成员函数)全局变量(包括全局和命名空间域下的变量,类静态变量),
11、局部变量,函数参数,类、结构体和联合体中的成员变量常量(const),枚举值宏命名空间注意:上表中常量是指全局作用域、namespace域、类的静态成员域下,以 const或constexpr修饰的基本数据类型、枚举、字符串类型的变量。上表中_变量是指除常量定义以外的其他变量,均使用小驼峰风格。文件命名建议2.2.1 C+文件以.cpp结尾,头文件以.h结尾我们推荐使用.h作为头文件的后缀,这样头文件可以直接兼容C和C+。我们推荐使用.cpp作为实现文件的后缀,这样可以直接区分C+代码,而不是C代码。目前业界还有一些其他的后缀的表示方法: 头文件:.hh,.hpp,.hxx cpp 文件:.c
12、c,.cxx,.C对于本文档,我们默认使用.h和.cpp作为后缀。建议2.2.2 C+文件名和类名保持一致C+的头文件和cpp文件名和类名保持一致,使用下划线小写风格。如下:-database_connection.h - database_connection.cpp结构体,命名空间,枚举等定义的文件名类似。函数命名函数命名统一使用大驼峰风格,一般采用动词或者动宾结构。接口部分可加前缀,如XXX一函数名。class List public:void AddElement(const Elements element);Element GetElement(const unsigned int
13、 index) const;bool IsEmpty() const;bool MCC_GetClass(););namespace utils voidDeletellser();类型命名类型命名采用大驼峰命名风格。所有类型命名一一类、结构体、联合体、类型定义(typedef)、枚举使用相同约定,例如:/ cLasseSj structs and unionsclass UrlTable ,class UrlTableTester .struct UrlTableProperties union Packet / typedefstypedef std:map PropertiesMap;/
14、 enumsenum UrlTableErrors .对于命名空间的命名,建议全小写:/ namespacenamespace osutils namespace fileutils 建议2.4.1避免滥用typedef或者#define对基本类型起别名除有明确的必要性,否则不要用typedef/#define对基本数据类型进行重定义。优先使用头文件中的基本类型:有符号类型无符号类型描述int8_tuint8_t宽度恰为8的有/无符号整数类型intl6_tuintl6_t宽度恰为16的有/无符号整数类型int32_tuint32_t宽度恰为32的有/无符号整数类型int64_tuint64_t
15、宽度恰为64的有/无符号整数类型intptr_tuintptr_t足以保存指针的有/无符号整数类型如果模块有自己的定义,请使用统一的typedef来定义类型:typedef signed char VOS_INT8;typedef unsigned char VOS_U工NT8;#if_WORDSIZE =64typedef unsigned long int VOS_UINTPTR;#elsetypedef unsigned intVOS_UINTPTR;#endif如果模块为了封装某个类型的信息,方便后续的扩展,可以使用typedef来重新定义。typedef uint8_t Device
16、lD;/./若干版本后扩展成16-bittypedef uintl6_t DevicelD;有特殊作用的类型typedef void *Handle;注意:不要使用#define进行别名定义,并且在C+11以后推荐使用using来定义类型。除上述理由外,应避免给其本数值类型别名定义。因为类型别名可读性并不好,隐藏了基本数值类型信息,如位宽,是否带符号。滥用举例:typedef uintl6_t MyCounter;.int Foo() MyCounterc;-while (c =0) printf(counter =%dnC);/.)/.)对,MyCounter,是否可能小于0,打印时用,d,
17、还是,u,都不是很直观,极容易引入上述类似缺陷。变量命名通用变量命名采用小驼峰,包括全局变量,函数形参,局部变量,成员变量。std: string tableName;/ Good:推荐此风格std: string tablename;/ Bad:禁上此风格std:string path;/ Good:只仃个中.词时,小,花岭为的小写规则251类的成员变量命名使用小驼峰。class Foo private:std: string fileName;/不潦加任何作用域前缀或者后缀;当构造函数参数和成员变量重名时,可通过this,来引用成员变量。class MyClass public:MyCla
18、ss(int myVar): myVar(myVar)/ OK,初始化列表允许同人参初始化同名成员if (NeedNewVar()this-myVar = GetValue();/;匕起不要漏掠.否则就成给人医赋值)private:int myVar;宏、常量、枚举命名宏采用全大写,下划线连接的格式。常量、枚举值使用k+大小写混合。函数局部 const常量和类的普通const成员变量,使用小驼峰命名风格。ftdefine MAX(a, b)(a)(b)?(b):(a)/仅对宏命冬举例,并不推荐用宏实现此类功能enum TintColor /注意,枚举类型启用大驼峰,其下面的取值是大小7混合kR
19、edjkDarkRedjkGreen,kLightGreen;int Func(.)const unsigned int buffersize =100;/函数局部常/char *p = new charbufferSize;.namespace utils const unsigned int kFileSize =200;/企局常止)3格式尽管有些编程的排版风格因人而异,但是我们强烈建议和要求使用统一的编码风格,以便所有人都能够轻松的阅读和理解代码,增强代码的可维护性。行宽建议3.1.1行宽不超过120个字符建议每行字符数不要超过120个。如果超过120个字符,请选择合理的方式进行换行。例
20、外:如果一行注释包含了超过120个字符的命令或URL,则可以保持一行,以方便复制、粘贴和通过grep查找;包含长路径的include语句可以超出120个字符,但是也需要尽量避免;编译预处理中的error信息可以超出一行。预处理的error信息在一行便于阅读和理解,即使超过120个字符。#ifndef XXX_YYY_ZZZ#error Header aaaa/bbbb/cccc/abc.h must only be included after xxxx/yyy y/zzzz/xyz . h, because xxxxxxxxxxxxxxxxxxxxxxxxxxxxx#endif缩进规则3.2
21、.1使用空格进行缩进,每次缩进2个空格只允许使用空格(space)进行缩进,每次缩进为2个空格。大括号规则3.3.1除函数外,使用K&R缩进风格函数左大括号跟随语句放行末。右大括号独占一行,除非后面跟着同一语句的剩余部分,如do语句中的while,或者if语句的else/else if,或者逗号、分号。如:struct MyType /跟随语句放行末.前置1空格int Foo(int a)/函数左人括号跟随语句放行木if (.) else )推荐这种风格的理由: 代码更紧凑; 相比另起一行,放行末使代码阅读节奏感上更连续; 符合后来语言的习惯,符合业界主流习惯; 现代集成开发环境(IDE)都具
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 华为 语言 通用 编程 规范

限制150内