华为C++语言通用编程规范

章节内容0前言目的重点关注约定例外1原则好代码的原则类和函数设计指导原则保证静态类型安全遵循C++ISO标准优先编译时检查错误使用命名空间来限定作用域优先使用C++特性而不是C特性2命名通用命名文件命名函数命名类型命名变量命名宏、常量、枚举命名3格式行宽缩进大括号函数声明和定义函数调用if语句循环语句switch语句表达式变量赋值初始化指针和引用编译预处理空格和空行类4注释注释风格文件头注释函数头注释代码注释5头文件头文件职责头文件依赖6作用域命名空间全局函数和静态成员函数全局变量全局常量和静态成员常量7类构造、拷贝构造、赋值和析构函数继承多重继承重载8函数函数设计内联函数函数参数9C++其他特性常量与初始化表达式类型转换资源分配和释放标准库const的用法异常模板宏10现代C++特性代码简洁性和安全性提升智能指针Lambda接口0前言目的规则并不是完美的，通过禁止在特定情况下有用的特性，可能会对代码实现造成影响。但是我们制定规则的目的__“为了大多数程序员可以得到更多的好处”__，如果在团队运作中认为某个规则无法遵循，希望可以共同改进该规则。参考该规范之前，希望您具有相应的C++基础能力，而不是通过该文档来学习C++。1.了解C++的ISO标准；2.熟知C++的基本语言特性，包括C++03/11/14/17相关特性；3.了解C++的标准库；重点关注1.约定C++的编程风格，比如命名，排版等。2.C++的模块化设计，如何设计头文件，类，接口和函数。3.C++相关特性的优秀实践，比如常量，类型转换，资源管理，模板等。4.现代C++的优秀实践，包括C++11/14/17中可以提高代码可维护性，提高代码可靠性的相关约定。约定规则：编程时必须遵守的约定(must)建议：编程时应该遵守的约定(should)本规范适用通用C++标准,如果没有特定的标准版本，适用所有的版本(C++03/11/14/17)。例外无论是’规则’还是’建议’，都必须理解该条目这么规定的原因，并努力遵守。但是，有些规则和建议可能会有例外。在不违背总体原则，经过充分考虑，有充足的理由的前提下，可以适当违背规范中约定。例外破坏了代码的一致性，请尽量避免。’规则’的例外应该是极少的。下列情况，应风格一致性原则优先：修改外部开源代码、第三方代码时，应该遵守开源代码、第三方代码已有规范，保持风格统一。某些特定领域，优先参考其行业规范。1原则好代码的原则我们参考KentBeck的简单设计四原则来指导我们的如何写出优秀的代码，如何有效地判断我们的代码是优秀的。1.通过所有测试（Passesitstests）2.尽可能消除重复(Minimizesduplication)3.尽可能清晰表达(Maximizesclarity)4.更少代码元素(Hasfewerelements)5.以上四个原则的重要程度依次降低。这组定义被称做简单设计原则。第一条强调的是外部需求，这是代码实现最重要的；第二点就是代码的模块架构设计，保证代码的正交性，保证代码更容易修改；第三点是代码的可阅读性，保证代码是容易阅读的；最后一点才是保证代码是简洁的，在简洁和表达力之间，我们更看重表达力。类和函数设计指导原则C++是典型的面向对象编程语言，软件工程界已经有很多OOP原则来指导我们编写大规模的，高可扩展的，可维护性的代码：-高内聚，低耦合的基本原则-SOLID原则-迪米特法则-“Tell，Don’task”原则-组合/聚合复用原则保证静态类型安全我们希望C++应该是静态类型安全的，这样可以减少运行时的错误，提高代码的健壮性。但是由于C++的下面的特性存在，会破坏C++静态类型安全，我们针对这部分特性要仔细处理。-unions联合体-类型转换cast-缩窄转换narrowingconversions-类型退化typedecay-范围错误rangeerrors-void*类型指针我们可以通过约束这些特性的使用，或者使用C++的新特性，比如variant(C++17)，GSL的span，narrow_cast等来解决这些问题，提高C++代码的健壮性。遵循C++ISO标准希望通过使用ISOC++标准的特性来编写C++代码，对于ISO标准中未定义的或者编译器实现的特性要谨慎使用，对于GCC等编译器的提供的扩展特性也需要谨慎使用，这些特性会导致代码的可移植性比较差。注意：如果模块中需要使用相关的扩展特性来，那么尽可能将这些特性封装成独立的接口，并且可以通过编译选项关闭或者编译这些特性。对于这些扩展特性的使用，请模块制定特性编程指南来指导这些特性的使用。优先编译时检查错误通过编译器来优先保证代码健壮性，而不是通过编写错误处理代码来处理编译就可以发现的异常，比如：•通过const来保证数据的不变性，防止数据被无意修改。•通过gsl::span等来保证char数组不越界，而不是通过运行时的length检查。•通过static_assert来进行编译时检查。使用命名空间来限定作用域全局变量，全局常量和全局类型定义由于都属于全局作用域，在项目中，使用第三方库中容易出现冲突。命名空间将作用域细分为独立的，具名的作用域，可有效地防止全局作用域的命名冲突。1.class，struct等都具有自己的类作用域。2.具名的namespace可以实现类作用域更上层的作用域。3.匿名namespace和static可以实现文件作用域。对于没有作用域的宏变量，宏函数强烈建议不使用。作用域的一些缺点：1.虽然可以通过作用域来区分两个命名相同的类型，但是还是具有迷惑性。2.内联命名空间会让命名空间内部的成员摆脱限制，让人迷惑。3.通过多重嵌套来定义namespace，会让完整的命名空间比较冗长。所以，我们使用命名空间的建议如下：-对于变量，常量和类型定义尽可能使用namespace，减少全局作用域的冲突-不要在头文件中使用usingnamespace-不要使用内联命名空间-鼓励在.cpp文件中通过匿名namespace或者static来封装，防止不必要的定义通过API暴露出去。优先使用C++特性而不是C特性C++比起C语言更加类型安全，更加抽象。我们更推荐使用C++的语言特性来编程，比如使用string而不是char*,使用vector而不是原生数组，使用namespace而不是static。2命名通用命名常见命名风格有：驼峰风格(CamelCase)大小写字母混用，单词连在一起，不同单词间通过单词首字母大写来分开。按连接后的首字母是否大写，又分:大驼峰(UperCamelCase)和小驼峰(lowerCamelCase)内核风格(unix_like)单词全小写，用下划线分割。如：‘test_result’匈牙利风格在‘大驼峰’的基础上，加上前缀；前缀用于表达类型或用途。如：‘uiSavedCount’,‘bTested’规则2.1.1标识符命名使用驼峰风格不考虑匈牙利命名，在内核风格与驼峰风格之间，根据存量代码的情况，我们选择驼峰风格。类型命名风格类类型，结构体类型，枚举类型，联合体类型等类型定义大驼峰函数(包括全局函数，作用域函数，成员函数)大驼峰（接口部分可加前缀，如XXX_函数名）全局变量(包括全局和命名空间域下的变量，类静态变量)，局部变量，函数参数，类、结构体和联合体中的成员变量小驼峰常量(const)，枚举值k+大小写混合宏大写+下划线命名空间全小写注意：上表中__常量__是指全局作用域、namespace域、类的静态成员域下，以const或constexpr修饰的基本数据类型、枚举、字符串类型的变量。上表中__变量__是指除常量定义以外的其他变量，均使用小驼峰风格。文件命名建议2.2.1C++文件以.cpp结尾，头文件以.h结尾我们推荐使用.h作为头文件的后缀，这样头文件可以直接兼容C和C++。我们推荐使用.cpp作为实现文件的后缀，这样可以直接区分C++代码，而不是C代码。目前业界还有一些其他的后缀的表示方法：•头文件：.hh,.hpp,.hxx•cpp文件：.cc,.cxx,.C对于本文档，我们默认使用.h和.cpp作为后缀。建议2.2.2C++文件名和类名保持一致C++的头文件和cpp文件名和类名保持一致，使用下划线小写风格。如下：-database_connection.h-database_connection.cpp结构体，命名空间，枚举等定义的文件名类似。函数命名函数命名统一使用大驼峰风格，一般采用动词或者动宾结构。接口部分可加前缀，如XXX_函数名。classList{public:voidAddElement(constElement&element);ElementGetElement(constunsignedintindex)const;boolIsEmpty()const;boolMCC_GetClass();};namespaceutils{voidDeleteUser();}类型命名类型命名采用大驼峰命名风格。所有类型命名——类、结构体、联合体、类型定义（typedef）、枚举——使用相同约定，例如：//classes,structsandunionsclassUrlTable{...classUrlTableTester{...structUrlTableProperties{...unionPacket{...//typedefstypedefstd::mapstd::string,UrlTableProperties*PropertiesMap;//enumsenumUrlTableErrors{...对于命名空间的命名，建议全小写：//namespacenamespaceosutils{namespacefileutils{}}建议2.4.1避免滥用typedef或者#define对基本类型起别名除有明确的必要性，否则不要用typedef/#define对基本数据类型进行重定义。优先使用cstdint头文件中的基本类型：有符号类型无符号类型描述int8_tuint8_t宽度恰为8的有/无符号整数类型int16_tuint16_t宽度恰为16的有/无符号整数类型int32_tuint32_t宽度恰为32的有/无符号整数类型int64_tuint64_t宽度恰为64的有/无符号整数类型intptr_tuintptr_t足以保存指针的有/无符号整数类型如果模块有自己的定义，请使用统一的typedef来定义类型：typedefsignedcharVOS_INT8;typedefunsignedcharVOS_UINT8;#if__WORDSIZE==64typedefunsignedlongintVOS_UINTPTR;#elsetypedefunsignedintVOS_UINTPTR;#endif如果模块为了封装某个类型的信息，方便后续的扩展，可以使用typedef来重新定义。typedefuint8_tDeviceID;//...//若干版本后扩展成16-bittypedefuint16_tDeviceID;有特殊作用的类型typedefvoid*Handle;注意：不要使用#define进行别名定义，并且在C++11以后推荐使用using来定义类型。除上述理由外，应避免给其本数值类型别名定义。因为类型别名可读性并不好，隐藏了基本数值类型信息，如位宽，是否带符号。滥用举例：typedefuint16_tMyCounter;//...intFoo(...){MyCounterc;//...while(c=0){printf(counter=%d\n,c);//...}//...}对’MyCounter’是否可能小于0，打印时用’%d’还是’%u’都不是很直观，极容易引入上述类似缺陷。变量命名通用变量命名采用小驼峰，包括全局变量，函数形参，局部变量，成员变量。std::stringtableName;//Good:推荐此风格std::stringtablename;//Bad:禁