华为C++编程规范

• 华为C++编程规范

C++语言编程规范

目的

规则并不是完美的，通过禁止在特定情况下有用的特性，可能会对代码实现造成影响。但是我们制定规则的目的“为了大多数程序员可以得到更多的好处”， 如果在团队运作中认为某个规则无法遵循，希望可以共同改进该规则。 参考该规范之前，希望您具有相应的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中可以提高代码可维护性，提高代码可靠性的相关约定。
5. 本规范优先适于用C++17版本。

约定

规则：编程时必须遵守的约定(must)

建议：编程时应该遵守的约定(should)

本规范适用通用C++标准, 如果没有特定的标准版本，适用所有的版本(C++03/11/14/17)。

例外

无论是’规则’还是’建议’，都必须理解该条目这么规定的原因，并努力遵守。 但是，有些规则和建议可能会有例外。

在不违背总体原则，经过充分考虑，有充足的理由的前提下，可以适当违背规范中约定。 例外破坏了代码的一致性，请尽量避免。‘规则’的例外应该是极少的。

下列情况，应风格一致性原则优先： 修改外部开源代码、第三方代码时，应该遵守开源代码、第三方代码已有规范，保持风格统一。

2 命名

通用命名

驼峰风格(CamelCase) 大小写字母混用，单词连在一起，不同单词间通过单词首字母大写来分开。 按连接后的首字母是否大写，又分: 大驼峰(UpperCamelCase)和小驼峰(lowerCamelCase)

注意： 上表中__常量__是指全局作用域、namespace域、类的静态成员域下，以 const或constexpr 修饰的基本数据类型、枚举、字符串类型的变量，不包括数组和其他类型变量。 上表中__变量__是指除常量定义以外的其他变量，均使用小驼峰风格。

文件命名

规则2.2.1 C++文件以.cpp结尾，头文件以.h结尾

我们推荐使用.h作为头文件的后缀，这样头文件可以直接兼容C和C++。 我们推荐使用.cpp作为实现文件的后缀，这样可以直接区分C++代码，而不是C代码。

目前业界还有一些其他的后缀的表示方法：

• 头文件： .hh, .hpp, .hxx
• cpp文件：.cc, .cxx, .c

如果当前项目组使用了某种特定的后缀，那么可以继续使用，但是请保持风格统一。 但是对于本文档，我们默认使用.h和.cpp作为后缀。

规则2.2.2 C++文件名和类名保持一致

C++的头文件和cpp文件名和类名保持一致，使用下划线小写风格。

如果有一个类叫DatabaseConnection，那么对应的文件名：

• database_connection.h
• database_connection.cpp

结构体，命名空间，枚举等定义的文件名类似。

函数命名

函数命名统一使用大驼峰风格，一般采用动词或者动宾结构。

class List {
public:
	void AddElement(const Element& element);
	Element GetElement(const unsigned int index) const;
	bool IsEmpty() const;
};

namespace Utils {
    void DeleteUser();
}

类型命名

类型命名采用大驼峰命名风格。 所有类型命名——类、结构体、联合体、类型定义（typedef）、枚举——使用相同约定，例如：

// classes, structs and unions
class UrlTable { ...
class UrlTableTester { ...
struct UrlTableProperties { ...
union Packet { ...

// typedefs
typedef std::map<std::string, UrlTableProperties*> PropertiesMap;

// enums
enum UrlTableErrors { ...

对于命名空间的命名，建议使用大驼峰：

// namespace
namespace OsUtils {
 
namespace FileUtils {
     
}
 
}

建议2.4.1 避免滥用 typedef或者#define 对基本类型起别名

除有明确的必要性，否则不要用 typedef/#define 对基本数据类型进行重定义。 优先使用<cstdint>头文件中的基本类型：

变量命名

通用变量命名采用小驼峰，包括全局变量，函数形参，局部变量，成员变量。

std::string tableName;  // Good: 推荐此风格
std::string tablename;  // Bad: 禁止此风格
std::string path;       // Good: 只有一个单词时，小驼峰为全小写

规则2.5.1 全局变量应增加 ‘g_’ 前缀，静态变量命名不需要加特殊前缀

全局变量是应当尽量少使用的，使用时应特别注意，所以加上前缀用于视觉上的突出，促使开发人员对这些变量的使用更加小心。

• 全局静态变量命名与全局变量相同。
• 函数内的静态变量命名与普通局部变量相同。
• 类的静态成员变量和普通成员变量相同。

int g_activeConnectCount;

void Func()
{
    static int packetCount = 0; 
    ...
}

规则2.5.2 类的成员变量命名以小驼峰加后下划线组成

class Foo {
private:
    std::string fileName_;   // 添加_后缀，类似于K&R命名风格
};

对于struct/union的成员变量，仍采用小驼峰不加后缀的命名方式，与局部变量命名风格一致。

宏、常量、枚举命名

宏、枚举值采用全大写，下划线连接的格式。 全局作用域内，有名和匿名namespace内的 const 常量，类的静态成员常量，全大写，下划线连接；函数局部 const 常量和类的普通const成员变量，使用小驼峰命名风格。

#define MAX(a, b)   (((a) < (b)) ? (b) : (a)) // 仅对宏命名举例，并不推荐用宏实现此类功能

enum TintColor {    // 注意，枚举类型名用大驼峰，其下面的取值是全大写，下划线相连
    RED,
    DARK_RED,
    GREEN,
    LIGHT_GREEN
};

int Func(...)
{
    const unsigned int bufferSize = 100;    // 函数局部常量
    char *p = new char[bufferSize];
    ...
}

namespace Utils {
	const unsigned int DEFAULT_FILE_SIZE_KB = 200;        // 全局常量
}

3 格式

行宽

规则3.1.1 行宽不超过 120 个字符

建议每行字符数不要超过 120 个。如果超过120个字符，请选择合理的方式进行换行。

例外:

• 如果一行注释包含了超过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/yyyy/zzzz/xyz.h, because xxxxxxxxxxxxxxxxxxxxxxxxxxxxx
#endif

缩进

规则3.2.1 使用空格进行缩进，每次缩进4个空格

只允许使用空格(space)进行缩进，每次缩进为 4 个空格。不允许使用Tab符进行缩进。 当前几乎所有的集成开发环境（IDE）都支持配置将Tab符自动扩展为4空格输入；请配置你的IDE支持使用空格进行缩进。

大括号

规则3.3.1 使用 K&R 缩进风格

K&R风格 换行时，函数（不包括lambda表达式）左大括号另起一行放行首，并独占一行；其他左大括号跟随语句放行末。 右大括号独占一行，除非后面跟着同一语句的剩余部分，如 do 语句中的 while，或者 if 语句的 else/else if，或者逗号、分号。

如：

struct MyType {     // 跟随语句放行末，前置1空格
    ...
};

int Foo(int a)
{                   // 函数左大括号独占一行，放行首
    if (...) {
        ...
    } else {
        ...
    }
}

推荐这种风格的理由：

• 代码更紧凑；
• 相比另起一行，放行末使代码阅读节奏感上更连续；
• 符合后来语言的习惯，符合业界主流习惯；
• 现代集成开发环境（IDE）都具有代码缩进对齐显示的辅助功能，大括号放在行尾并不会对缩进和范围产生理解上的影响。

对于空函数体，可以将大括号放在同一行：

class MyClass {
public:
    MyClass() : value_(0) {}
   
private:
    int value_;
};

函数声明和定义

规则3.4.1 函数声明和定义的返回类型和函数名在同一行；函数参数列表超出行宽时要换行并合理对齐

在声明和定义函数的时候，函数的返回值类型应该和函数名在同一行；如果行宽度允许，函数参数也应该放在一行；否则，函数参数应该换行，并进行合理对齐。 参数列表的左圆括号总是和函数名在同一行，不要单独一行；右圆括号总是跟随最后一个参数。

换行举例：

ReturnType FunctionName(ArgType paramName1, ArgType paramName2)   // Good：全在同一行
{
    ...
}

ReturnType VeryVeryVeryLongFunctionName(ArgType paramName1,     // 行宽不满足所有参数，进行换行
                                        ArgType paramName2,     // Good：和上一行参数对齐
                                        ArgType paramName3)
{
    ...
}

ReturnType LongFunctionName(ArgType paramName1, ArgType paramName2, // 行宽限制，进行换行
    ArgType paramName3, ArgType paramName4, ArgType paramName5)     // Good: 换行后 4 空格缩进
{
    ...
}

ReturnType ReallyReallyReallyReallyLongFunctionName(            // 行宽不满足第1个参数，直接换行
    ArgType paramName1, ArgType paramName2, ArgType paramName3) // Good: 换行后 4 空格缩进
{
    ...
}

函数调用

规则3.5.1 函数调用入参列表应放在一行，超出行宽换行时，保持参数进行合理对齐

函数调用时，函数参数列表放在一行。参数列表如果超过行宽，需要换行并进行合理的参数对齐。 左圆括号总是跟函数名，右圆括号总是跟最后一个参数。

换行举例：

ReturnType result = FunctionName(paramName1, paramName2);   // Good：函数参数放在一行

ReturnType result = FunctionName(paramName1,
                                 paramName2,                // Good：保持与上方参数对齐
                                 paramName3);

ReturnType result = FunctionName(paramName1, paramName2,
    paramName3, paramName4, paramName5);                    // Good：参数换行，4 空格缩进

ReturnType result = VeryVeryVeryLongFunctionName(           // 行宽不满足第1个参数，直接换行
    paramName1, paramName2, paramName3);                    // 换行后，4 空格缩进

如果函数调用的参数存在内在关联性，按照可理解性优先于格式排版要求，对参数进行合理分组换行。

// Good：每行的参数代表一组相关性较强的数据结构，放在一行便于理解
int result = DealWithStructureLikeParams(left.x, left.y,     // 表示一组相关参数
                                         right.x, right.y);  // 表示另外一组相关参数

if语句

规则3.6.1 if语句必须要使用大括号

我们要求if语句都需要使用大括号，即便只有一条语句。

理由：

• 代码逻辑直观，易读；
• 在已有条件语句代码上增加新代码时不容易出错；
• 对于在if语句中使用函数式宏时，有大括号保护不易出错（如果宏定义时遗漏了大括号）。

if (objectIsNotExist) {         // Good：单行条件语句也加大括号
    return CreateNewObject();
}

规则3.6.2 禁止 if/else/else if 写在同一行

条件语句中，若有多个分支，应该写在不同行。

如下是正确的写法：

if (someConditions) {
    DoSomething();
    ...
} else {  // Good: else 与 if 在不同行
    ...
}

下面是不符合规范的案例：

if (someConditions) { ... } else { ... } // Bad: else 与 if 在同一行

循环语句

规则3.7.1 循环语句必须使用大括号

和条件表达式类似，我们要求for/while循环语句必须加上大括号，即便循环体是空的，或循环语句只有一条。

for (int i = 0; i < someRange; i++) {   // Good: 使用了大括号
    DoSomething();
}

while (condition) { }   // Good：循环体是空，使用大括号

while (condition) {
    continue;           // Good：continue 表示空逻辑，使用大括号
}

坏的例子：

for (int i = 0; i < someRange; i++)
    DoSomething();      // Bad: 应该加上括号

while (condition);      // Bad：使用分号容易让人误解是while语句中的一部分

switch语句

规则3.8.1 switch 语句的 case/default 要缩进一层

switch 语句的缩进风格如下：

switch (var) {
    case 0:             // Good: 缩进
        DoSomething1(); // Good: 缩进
        break;
    case 1: {           // Good: 带大括号格式
        DoSomething2();
        break;
    }
    default:
        break;
}

switch (var) {
case 0:                 // Bad: case 未缩进
    DoSomething();
    break;
default:                // Bad: default 未缩进
    break;
}

表达式

建议3.9.1 表达式换行要保持换行的一致性，运算符放行末

较长的表达式，不满足行宽要求的时候，需要在适当的地方换行。一般在较低优先级运算符或连接符后面截断，运算符或连接符放在行末。 运算符、连接符放在行末，表示“未结束，后续还有”。 例：

// 假设下面第一行已经不满足行宽要求

if ((currentValue > threshold) &&  // Good：换行后，逻辑操作符放在行尾
    someCondition) {
    DoSomething();
    ...
}

int result = reallyReallyLongVariableName1 +    // Good
             reallyReallyLongVariableName2;

表达式换行后，注意保持合理对齐，或者4空格缩进。参考下面例子

int sum = longVariableName1 + longVariableName2 + longVariableName3 +
    longVariableName4 + longVariableName5 + longVariableName6;         // Good: 4空格缩进

int sum = longVariableName1 + longVariableName2 + longVariableName3 +
          longVariableName4 + longVariableName5 + longVariableName6;   // Good: 保持对齐

变量赋值

规则3.10.1 多个变量定义和赋值语句不允许写在一行

每行只有一个变量初始化的语句，更容易阅读和理解。

int maxCount = 10;
bool isCompleted = false;

下面是不符合规范的示例：

int maxCount = 10; bool isCompleted = false; // Bad：多个变量初始化需要分开放在多行，每行一个变量初始化
int x, y = 0;  // Bad：多个变量定义需要分行，每行一个

int pointX;
int pointY;
...
pointX = 1; pointY = 2;  // Bad：多个变量赋值语句放同一行

例外：for 循环头、if 初始化语句（C++17）、结构化绑定语句（C++17）中可以声明和初始化多个变量。这些语句中的多个变量声明有较强关联，如果强行分成多行会带来作用域不一致，声明和初始化割裂等问题。

初始化

初始化包括结构体、联合体、及数组的初始化

规则3.11.1 初始化换行时要有缩进，并进行合理对齐

结构体或数组初始化时，如果换行应保持4空格缩进。 从可读性角度出发，选择换行点和对齐位置。

const int rank[] = {
    16, 16, 16, 16, 32, 32, 32, 32,
    64, 64, 64, 64, 32, 32, 32, 32
};

指针与引用

建议3.12.1 指针类型"*“跟随变量名或者类型，不要两边都留有或者都没有空格

指针命名: *靠左靠右都可以，但是不要两边都有或者都没有空格。

int* p = nullptr;  // Good
int *p = nullptr;  // Good

int*p = nullptr;   // Bad
int * p = nullptr; // Bad

例外：当变量被 const 修饰时，"*” 无法跟随变量，此时也不要跟随类型。

const char * const VERSION = "V100";

建议3.12.2 引用类型"&“跟随变量名或者类型，不要两边都留有或者都没有空格

引用命名：&靠左靠右都可以，但是不要两边都有或者都没有空格。

int i = 8;

int& p = i;     // Good
int &p = i;     // Good
int*& rp = pi;  // Good，指针的引用，*& 一起跟随类型
int *&rp = pi;  // Good，指针的引用，*& 一起跟随变量名
int* &rp = pi;  // Good，指针的引用，* 跟随类型，& 跟随变量名

int & p = i;    // Bad
int&p = i;      // Bad

编译预处理

规则3.13.1 编译预处理的”#“统一放在行首，嵌套编译预处理语句时，”#“可以进行缩进

编译预处理的”#“统一放在行首，即使编译预处理的代码是嵌入在函数体中的，”#“也应该放在行首。

规则3.13.2 避免使用宏

宏会忽略作用域，类型系统以及各种规则，容易引发问题。应尽量避免使用宏定义，如果必须使用宏，要保证证宏名的唯一性。 在C++中，有许多方式来避免使用宏：

• 用const或enum定义易于理解的常量
• 用namespace避免名字冲突
• 用inline函数避免函数调用的开销
• 用template函数来处理多种类型

在文件头保护宏、条件编译、日志记录等必要场景中可以使用宏。

规则3.13.3 禁止使用宏来表示常量

宏是简单的文本替换，在预处理阶段完成，运行报错时直接报相应的值；跟踪调试时也是显示值，而不是宏名； 宏没有类型检查，不安全； 宏没有作用域。

规则3.13.4 禁止使用函数式宏

宏义函数式宏前，应考虑能否用函数替代。对于可替代场景，建议用函数替代宏。 函数式宏的缺点如下：

• 函数式宏缺乏类型检查，不如函数调用检查严格
• 宏展开时宏参数不求值，可能会产生非预期结果
• 宏没有独立的作用域
• 宏的技巧性太强，例如#的用法和无处不在的括号，影响可读性
• 在特定场景中必须用编译器对宏的扩展语法，如GCC的statement expression，影响可移植性
• 宏在预编译阶段展开后，在期后编译、链接和调试时都不可见；而且包含多行的宏会展开为一行。函数式宏难以调试、难以打断点，不利于定位问题
• 对于包含大量语句的宏，在每个调用点都要展开。如果调用点很多，会造成代码空间的膨胀

函数没有宏的上述缺点。但是，函数相比宏，最大的劣势是执行效率不高（增加函数调用的开销和编译器优化的难度）。 为此，可以在必要时使用内联函数。内联函数跟宏类似，也是在调用点展开。不同之处在于内联函数是在编译时展开。

内联函数兼具函数和宏的优点：

• 内联函数执行严格的类型检查
• 内联函数的参数求值只会进行一次
• 内联函数就地展开，没有函数调用的开销
• 内联函数比函数优化得更好

对于性能要求高的产品代码，可以考虑用内联函数代替函数。

例外： 在日志记录场景中，需要通过函数式宏保持调用点的文件名（FILE）、行号（LINE）等信息。

空格和空行

规则3.14.1 水平空格应该突出关键字和重要信息，避免不必要的留白

水平空格应该突出关键字和重要信息，每行代码尾部不要加空格。总体规则如下：

• if, switch, case, do, while, for等关键字之后加空格；
• 小括号内部的两侧，不要加空格；
• 大括号内部两侧有无空格，左右必须保持一致；
• 一元操作符（& * + ‐ ~ !）之后不要加空格；
• 二元操作符（= + ‐ < > * / % | & ^ <= >= == != ）左右两侧加空格
• 三目运算符（? :）符号两侧均需要空格
• 前置和后置的自增、自减（++ –）和变量之间不加空格
• 结构体成员操作符（. ->）前后不加空格
• 逗号(,)前面不加空格，后面增加空格
• 对于模板和类型转换(<>)和类型之间不要添加空格
• 域操作符(::)前后不要添加空格
• 冒号(:)前后根据情况来判断是否要添加空格

常规情况：

void Foo(int b) {  // Good：大括号前应该留空格

int i = 0;  // Good：变量初始化时，=前后应该有空格，分号前面不要留空格

int buf[BUF_SIZE] = {0};    // Good：大括号内两侧都无空格

函数定义和函数调用：

int result = Foo(arg1,arg2);
                    ^    // Bad: 逗号后面需要增加空格

int result = Foo( arg1, arg2 );
                 ^          ^  // Bad: 函数参数列表的左括号后面不应该有空格，右括号前面不应该有空格

指针和取地址

x = *p;     // Good：*操作符和指针p之间不加空格
p = &x;     // Good：&操作符和变量x之间不加空格
x = r.y;    // Good：通过.访问成员变量时不加空格
x = r->y;   // Good：通过->访问成员变量时不加空格

操作符：

x = 0;   // Good：赋值操作的=前后都要加空格
x = -5;  // Good：负数的符号和数值之前不要加空格
++x;     // Good：前置和后置的++/--和变量之间不要加空格
x--;

if (x && !y)  // Good：布尔操作符前后要加上空格，！操作和变量之间不要空格
v = w * x + y / z;  // Good：二元操作符前后要加空格
v = w * (x + z);    // Good：括号内的表达式前后不需要加空格

int a = (x < y) ? x : y;  // Good: 三目运算符， ？和：前后需要添加空格

循环和条件语句：

if (condition) {  // Good：if关键字和括号之间加空格，括号内条件语句前后不加空格
    ...
} else {           // Good：else关键字和大括号之间加空格
    ...
}

while (condition) {}   // Good：while关键字和括号之间加空格，括号内条件语句前后不加空格

for (int i = 0; i < someRange; ++i) {  // Good：for关键字和括号之间加空格，分号之后加空格
    ...
}

switch (condition) {  // Good: switch 关键字后面有1空格
    case 0:     // Good：case语句条件和冒号之间不加空格
        ...
        break;
    ...
    default:
        ...
        break;
}

模板和转换

// 尖括号(< and >) 不与空格紧邻, < 前没有空格, > 和 ( 之间也没有.
vector<string> x;
y = static_cast<char*>(x);

// 在类型与指针操作符之间留空格也可以, 但要保持一致.
vector<char *> x;

域操作符

std::cout;    // Good: 命名空间访问，不要留空格

int MyClass::GetValue() const {}  // Good: 对于成员函数定义，不要留空格

冒号

// 添加空格的场景

// Good: 类的派生需要留有空格
class Sub : public Base {
   
};

// 构造函数初始化列表需要留有空格
MyClass::MyClass(int var) : someVar_(var)
{
    DoSomething();
}

// 位域表示也留有空格
struct XX {
    char a : 4;    
    char b : 5;    
    char c : 4;
};

// 不添加空格的场景

// Good: 对于public:, private:这种类访问权限的冒号不用添加空格
class MyClass {
public:
    MyClass(int var);
private:
    int someVar_;
};

// 对于switch-case的case和default后面的冒号不用添加空格
switch (value)
{
    case 1:
        DoSomething();
        break;
    default:
        break;
}

注意：当前的集成开发环境（IDE）可以设置删除行尾的空格，请正确配置。

建议3.14.1 合理安排空行，保持代码紧凑

减少不必要的空行，可以显示更多的代码，方便代码阅读。下面有一些建议遵守的规则：

• 根据上下内容的相关程度，合理安排空行；
• 函数内部、类型定义内部、宏内部、初始化表达式内部，不使用连续空行
• 不使用连续 3 个空行，或更多
• 大括号内的代码块行首之前和行尾之后不要加空行，但namespace的大括号内不作要求。

int Foo()
{
    ...
}



int Bar()  // Bad：最多使用连续2个空行。
{
    ...
}


if (...) {
        // Bad：大括号内的代码块行首不要加入空行
    ...
        // Bad：大括号内的代码块行尾不要加入空行
}

int Foo(...)
{
        // Bad：函数体内行首不要加空行
    ...
}

类

规则3.15.1 类访问控制块的声明依次序是 public:, protected:, private:，缩进和 class 关键字对齐

class MyClass : public BaseClass {
public:      // 注意没有缩进
    MyClass();  // 标准的4空格缩进
    explicit MyClass(int var);
    ~MyClass() {}

    void SomeFunction();
    void SomeFunctionThatDoesNothing()
    {
    }

    void SetVar(int var) { someVar_ = var; }
    int GetVar() const { return someVar_; }

private:
    bool SomeInternalFunction();

    int someVar_;
    int someOtherVar_;
};

在各个部分中，建议将类似的声明放在一起, 并且建议以如下的顺序: 类型 (包括 typedef, using 和嵌套的结构体与类), 常量, 工厂函数, 构造函数, 赋值运算符, 析构函数, 其它成员函数, 数据成员。

规则3.15.2 构造函数初始化列表放在同一行或按四格缩进并排多行

// 如果所有变量能放在同一行:
MyClass::MyClass(int var) : someVar_(var)
{
    DoSomething();
}

// 如果不能放在同一行,
// 必须置于冒号后, 并缩进4个空格
MyClass::MyClass(int var)
    : someVar_(var), someOtherVar_(var + 1)  // Good: 逗号后面留有空格
{
    DoSomething();
}

// 如果初始化列表需要置于多行, 需要逐行对齐
MyClass::MyClass(int var)
    : someVar_(var),             // 缩进4个空格
      someOtherVar_(var + 1)
{ 
    DoSomething();
}

4 注释

一般的，尽量通过清晰的架构逻辑，好的符号命名来提高代码可读性；需要的时候，才辅以注释说明。 注释是为了帮助阅读者快速读懂代码，所以要从读者的角度出发，按需注释。

注释内容要简洁、明了、无二义性，信息全面且不冗余。

注释跟代码一样重要。 写注释时要换位思考，用注释去表达此时读者真正需要的信息。在代码的功能、意图层次上进行注释，即注释解释代码难以表达的意图，不要重复代码信息。 修改代码时，也要保证其相关注释的一致性。只改代码，不改注释是一种不文明行为，破坏了代码与注释的一致性，让阅读者迷惑、费解，甚至误解。

使用英文进行注释。

注释风格

在 C++ 代码中，使用 /* */和 // 都是可以的。 按注释的目的和位置，注释可分为不同的类型，如文件头注释、函数头注释、代码注释等等； 同一类型的注释应该保持统一的风格。

注意：本文示例代码中，大量使用 ‘//’ 后置注释只是为了更精确的描述问题，并不代表这种注释风格更好。

文件头注释

规则3.1 文件头注释必须包含版权许可

/*

• Copyright (c) 2020 XXX
• Licensed under the Apache License, Version 2.0 (the “License”);
• you may not use this file except in compliance with the License.
• You may obtain a copy of the License at *

• http://www.apache.org/licenses/LICENSE-2.0
  

*

• Unless required by applicable law or agreed to in writing, software
• distributed under the License is distributed on an “AS IS” BASIS,
• WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
• See the License for the specific language governing permissions and
• limitations under the License. */

函数头注释

规则4.3.1 公有（public）函数必须编写函数头注释

公有函数属于类对外提供的接口，调用者需要了解函数的功能、参数的取值范围、返回的结果、注意事项等信息才能正常使用。 特别是参数的取值范围、返回的结果、注意事项等都无法做到自注示，需要编写函数头注释辅助说明。

规则4.3.2 禁止空有格式的函数头注释

并不是所有的函数都需要函数头注释； 函数签名无法表达的信息，加函数头注释辅助说明;

函数头注释统一放在函数声明或定义上方，使用如下风格之一： 使用//写函数头

// 单行函数头
int Func1(void);

// 多行函数头
// 第二行
int Func2(void);

使用/* */写函数头

/* 单行函数头 */
int Func1(void);

/*
 * 另一种单行函数头
 */
int Func2(void);

/*
 * 多行函数头
 * 第二行
 */
int Func3(void);

函数尽量通过函数名自注释，按需写函数头注释。 不要写无用、信息冗余的函数头；不要写空有格式的函数头。

函数头注释内容可选，但不限于：功能说明、返回值，性能约束、用法、内存约定、算法实现、可重入的要求等等。 模块对外头文件中的函数接口声明，其函数头注释，应当将重要、有用的信息表达清楚。

例：

/*
 * 返回实际写入的字节数，-1表示写入失败
 * 注意，内存 buf 由调用者负责释放
 */
int WriteString(const char *buf, int len);

坏的例子：

/*
 * 函数名：WriteString
 * 功能：写入字符串
 * 参数：
 * 返回值：
 */
int WriteString(const char *buf, int len);

上面例子中的问题：

• 参数、返回值，空有格式没内容
• 函数名信息冗余
• 关键的 buf 由谁释放没有说清楚

代码注释

规则4.4.1 代码注释放于对应代码的上方或右边

规则4.4.2 注释符与注释内容间要有1空格；右置注释与前面代码至少1空格

代码上方的注释，应该保持对应代码一样的缩进。 选择并统一使用如下风格之一： 使用//

// 这是单行注释
DoSomething();

// 这是多行注释
// 第二行
DoSomething();

使用/*' '*/

/* 这是单行注释 */
DoSomething();

/*
 * 另一种方式的多行注释
 * 第二行
 */
DoSomething();

代码右边的注释，与代码之间，至少留1空格，建议不超过4空格。 通常使用扩展后的 TAB 键即可实现 1-4 空格的缩进。

选择并统一使用如下风格之一：

int foo = 100;  // 放右边的注释
int bar = 200;  /* 放右边的注释 */

右置格式在适当的时候，上下对齐会更美观。 对齐后的注释，离左边代码最近的那一行，保证1-4空格的间隔。 例：

const int A_CONST = 100;         /* 相关的同类注释，可以考虑上下对齐 */
const int ANOTHER_CONST = 200;   /* 上下对齐时，与左侧代码保持间隔 */

当右置的注释超过行宽时，请考虑将注释置于代码上方。

规则4.4.3 不用的代码段直接删除，不要注释掉

被注释掉的代码，无法被正常维护；当企图恢复使用这段代码时，极有可能引入易被忽略的缺陷。 正确的做法是，不需要的代码直接删除掉。若再需要时，考虑移植或重写这段代码。

这里说的注释掉代码，包括用 /* */ 和 //，还包括 #if 0， #ifdef NEVER_DEFINED 等等。

5 头文件

头文件职责

头文件是模块或文件的对外接口，头文件的设计体现了大部分的系统设计。 头文件中适合放置接口的声明，不适合放置实现（内联函数除外）。对于cpp文件中内部才需要使用的函数、宏、枚举、结构定义等不要放在头文件中。 头文件应当职责单一。头文件过于复杂，依赖过于复杂还是导致编译时间过长的主要原因。

建议5.1.1 每一个.cpp文件应有一个对应的.h文件，用于声明需要对外公开的类与接口

通常情况下，每个.cpp文件都有一个相应的.h，用于放置对外提供的函数声明、宏定义、类型定义等。 如果一个.cpp文件不需要对外公布任何接口，则其就不应当存在。 例外：程序的入口（如main函数所在的文件），单元测试代码，动态库代码。

示例:

// Foo.h

#ifndef FOO_H
#define FOO_H

class Foo {
public:
    Foo();
    void Fun();
   
private:
    int value_;
};

#endif

// Foo.cpp
#include "Foo.h"

namespace { // Good: 对内函数的声明放在.cpp文件的头部，并声明为匿名namespace或者static限制其作用域
    void Bar()
    {
    }
}

...

void Foo::Fun()
{
    Bar();
}

头文件依赖

规则5.2.1 禁止头文件循环依赖

头文件循环依赖，指 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的源代码重新编译。

头文件循环依赖直接体现了架构设计上的不合理，可通过优化架构去避免。

规则5.2.2 头文件必须编写#define保护，防止重复包含

为防止头文件被重复包含，所有头文件都应当使用 #define 保护；不要使用 #pragma once

定义包含保护符时，应该遵守如下规则： 1）保护符使用唯一名称； 2）不要在受保护部分的前后放置代码或者注释，文件头注释除外。

示例：假定timer模块的timer.h，其目录为timer/include/timer.h,应按如下方式保护：

#ifndef TIMER_INCLUDE_TIMER_H
#define TIMER_INCLUDE_TIMER_H
...
#endif

规则5.2.3 禁止通过声明的方式引用外部函数接口、变量

只能通过包含头文件的方式使用其他模块或文件提供的接口。 通过 extern 声明的方式使用外部函数接口、变量，容易在外部接口改变时可能导致声明和定义不一致。 同时这种隐式依赖，容易导致架构腐化。

不符合规范的案例：

// a.cpp内容

extern int Fun();   // Bad: 通过extern的方式使用外部函数

void Bar()
{
    int i = Fun();
    ...
}

// b.cpp内容

int Fun()
{
    // Do something
}

应该改为：

// a.cpp内容

#include "b.h"   // Good: 通过包含头文件的方式使用其他.cpp提供的接口

void Bar()
{
    int i = Fun();
    ...
}

// b.h内容

int Fun();

// b.cpp内容

int Fun()
{
    // Do something
}

例外，有些场景需要引用其内部函数，但并不想侵入代码时，可以 extern 声明方式引用。 如： 针对某一内部函数进行单元测试时，可以通过 extern 声明来引用被测函数； 当需要对某一函数进行打桩、打补丁处理时，允许 extern 声明该函数。

规则5.2.4 禁止在extern “C"中包含头文件

在 extern “C” 中包含头文件，有可能会导致 extern “C” 嵌套，部分编译器对 extern “C” 嵌套层次有限制，嵌套层次太多会编译错误。

在C，C++混合编程的情况下，在extern “C"中包含头文件，可能会导致被包含头文件的原有意图遭到破坏，比如链接规范被不正确地更改。

示例，存在a.h和b.h两个头文件：

// a.h内容

...
#ifdef __cplusplus
void Foo(int);
#define A(value) Foo(value)
#else
void A(int)
#endif

// b.h内容

...
#ifdef __cplusplus
extern "C" {
#endif

#include "a.h"
void B();

#ifdef __cplusplus
}
#endif

使用C++预处理器展开b.h，将会得到

extern "C" {
    void Foo(int);
    void B();
}

按照 a.h 作者的本意，函数 Foo 是一个 C++ 自由函数，其链接规范为 “C++"。 但在 b.h 中，由于 #include "a.h" 被放到了 extern "C" 的内部，函数 Foo 的链接规范被不正确地更改了。

例外： 如果在 C++ 编译环境中，想引用纯C的头文件，这些C头文件并没有 extern "C" 修饰。非侵入式的做法是，在 extern "C" 中去包含C头文件。

建议5.2.1尽量避免使用前置声明，而是通过#include来包含头文件

前置声明（forward declaration）通常指类、模板的纯粹声明，没伴随着其定义。

• 优点：
  1. 前置声明能够节省编译时间，多余的 #include 会迫使编译器展开更多的文件，处理更多的输入。
  2. 前置声明能够节省不必要的重新编译的时间。 #include 使代码因为头文件中无关的改动而被重新编译多次。
• 缺点：
  1. 前置声明隐藏了依赖关系，头文件改动时，用户的代码会跳过必要的重新编译过程。
  2. 前置声明可能会被库的后续更改所破坏。前置声明模板有时会妨碍头文件开发者变动其 API. 例如扩大形参类型，加个自带默认参数的模板形参等等。
  3. 前置声明来自命名空间 std:: 的 symbol 时，其行为未定义（在C++11标准规范中明确说明）。
  4. 前置声明了不少来自头文件的 symbol 时，就会比单单一行的 include 冗长。
  5. 仅仅为了能前置声明而重构代码（比如用指针成员代替对象成员）会使代码变得更慢更复杂。
  6. 很难判断什么时候该用前置声明，什么时候该用#include，某些场景下面前置声明和#include互换以后会导致意想不到的结果。

所以我们尽可能避免使用前置声明，而是使用#include头文件来保证依赖关系。

6 作用域

命名空间

建议6.1.1 对于cpp文件中不需要导出的变量，常量或者函数，请使用匿名namespace封装或者用static修饰

在C++ 2003标准规范中，使用static修饰文件作用域的变量，函数等被标记为deprecated特性，所以更推荐使用匿名namespace。

主要原因如下：

1. static在C++中已经赋予了太多的含义，静态函数成员变量，静态成员函数，静态全局变量，静态函数局部变量，每一种都有特殊的处理。
2. static只能保证变量，常量和函数的文件作用域，但是namespace还可以封装类型等。
3. 统一namespace来处理C++的作用域，而不需要同时使用static和namespace来管理。
4. static修饰的函数不能用来实例化模板，而匿名namespace可以。

但是不要在 .h 中使用中使用匿名namespace或者static。

// Foo.cpp

namespace {
    const int MAX_COUNT = 20;
    void InternalFun() {};
}

void Foo::Fun()
{
    int i = MAX_COUNT;
   
    InternalFun();
}

规则6.1.1 不要在头文件中或者#include之前使用using导入命名空间

说明：使用using导入命名空间会影响后续代码，易造成符号冲突，所以不要在头文件以及源文件中的#include之前使用using导入命名空间。 示例：

// 头文件a.h
namespace NamespaceA {
    int Fun(int);
}

// 头文件b.h
namespace NamespaceB {
    int Fun(int);
}

using namespace NamespaceB;

void G()
{
    Fun(1);
}

// 源代码a.cpp
#include "a.h"
using namespace NamespaceA;
#include "b.h"

void main()
{
    G(); // using namespace NamespaceA在#include “b.h”之前，引发歧义：NamespaceA::Fun，NamespaceB::Fun调用不明确
}

对于在头文件中使用using导入单个符号或定义别名，允许在模块自定义名字空间中使用，但禁止在全局名字空间中使用。

// foo.h

#include <fancy/string>
using fancy::string;  // Bad，禁止向全局名字空间导入符号

namespace Foo {
    using fancy::string;  // Good，可以在模块自定义名字空间中导入符号
    using MyVector = fancy::vector<int>;  // Good，C++11可在自定义名字空间中定义别名
}

全局函数和静态成员函数

建议6.2.1 优先使用命名空间来管理全局函数，如果和某个class有直接关系的，可以使用静态成员函数

说明：非成员函数放在名字空间内可避免污染全局作用域， 也不要用类+静态成员方法来简单管理全局函数。 如果某个全局函数和某个类有紧密联系， 那么可以作为类的静态成员函数。

如果你需要定义一些全局函数，给某个cpp文件使用，那么请使用匿名namespace来管理。

namespace MyNamespace {
    int Add(int a, int b);
}

class File {
public:
    static File CreateTempFile(const std::string& fileName);
};

全局常量和静态成员常量

建议6.3.1 优先使用命名空间来管理全局常量，如果和某个class有直接关系的，可以使用静态成员常量

说明：全局常量放在命名空间内可避免污染全局作用域， 也不要用类+静态成员常量来简单管理全局常量。 如果某个全局常量和某个类有紧密联系， 那么可以作为类的静态成员常量。

如果你需要定义一些全局常量，只给某个cpp文件使用，那么请使用匿名namespace来管理。

namespace MyNamespace {
    const int MAX_SIZE = 100;
}

class File {
public:
    static const std::string SEPARATOR;
};

全局变量

建议6.4.1 尽量避免使用全局变量，考虑使用单例模式

说明：全局变量是可以修改和读取的，那么这样会导致业务代码和这个全局变量产生数据耦合。

int g_counter = 0;

// a.cpp
g_counter++;

// b.cpp
g_counter++;

// c.cpp
cout << g_counter << endl;

使用单实例模式

class Counter {
public:
    static Counter& GetInstance()
    {
        static Counter counter;
        return counter;
    }  // 单实例实现简单举例
   
    void Increase()
    {
        value_++;
    }
   
    void Print() const
    {
        std::cout << value_ << std::endl;
    }

private:
    Counter() : value_(0) {}

private:
    int value_;
};

// a.cpp
Counter::GetInstance().Increase();

// b.cpp
Counter::GetInstance().Increase();

// c.cpp
Counter::GetInstance().Print();

实现单例模式以后，实现了全局唯一一个实例，和全局变量同样的效果，并且单实例提供了更好的封装性。

例外：有的时候全局变量的作用域仅仅是模块内部，这样进程空间里面就会有多个全局变量实例，每个模块持有一份，这种场景下是无法使用单例模式解决的。

7 类

构造，拷贝构造，赋值和析构函数

构造，拷贝，移动和析构函数提供了对象的生命周期管理方法：

• 构造函数（constructor）： X()
• 拷贝构造函数（copy constructor）：X(const X&)
• 拷贝赋值操作符（copy assignment）：operator=(const X&)
• 移动构造函数（move constructor）：X(X&&) C++11以后提供
• 移动赋值操作符（move assignment）：operator=(X&&) C++11以后提供
• 析构函数（destructor）：~X()

规则7.1.1 类的成员变量必须显式初始化

说明：如果类有成员变量，没有定义构造函数，又没有定义默认构造函数，编译器将自动生成一个构造函数，但编译器生成的构造函数并不会对成员变量进行初始化，对象状态处于一种不确定性。

例外：

• 如果类的成员变量具有默认构造函数，那么可以不需要显式初始化。

示例：如下代码没有构造函数，私有数据成员无法初始化：

class Message {
public:
    void ProcessOutMsg()
    {
        //…
    }

private:
    unsigned int msgID_;
    unsigned int msgLength_;
    unsigned char* msgBuffer_;
    std::string someIdentifier_;
};

Message message;   // message成员变量没有初始化
message.ProcessOutMsg();   // 后续使用存在隐患

// 因此，有必要定义默认构造函数，如下：
class Message {
public:
    Message() : msgID_(0), msgLength_(0), msgBuffer_(nullptr)
    {
    }

    void ProcessOutMsg()
    {
        // …
    }

private:
    unsigned int msgID_;
    unsigned int msgLength_;
    unsigned char* msgBuffer_;
    std::string someIdentifier_; // 具有默认构造函数，不需要显式初始化
};

建议7.1.1 成员变量优先使用声明时初始化（C++11）和构造函数初始化列表初始化

说明：C++11的声明时初始化可以一目了然的看出成员初始值，应当优先使用。如果成员初始化值和构造函数相关，或者不支持C++11，则应当优先使用构造函数初始化列表来初始化成员。相比起在构造函数体中对成员赋值，初始化列表的代码更简洁，执行性能更好，而且可以对const成员和引用成员初始化。

class Message {
public:
    Message() : msgLength_(0)  // Good，优先使用初始化列表
    {
        msgBuffer_ = nullptr;  // Bad，不推荐在构造函数中赋值
    }
   
private:
    unsigned int msgID_{0};  // Good，C++11中使用
    unsigned int msgLength_;
    unsigned char* msgBuffer_;
};

规则7.1.2 为避免隐式转换，将单参数构造函数声明为explicit

说明：单参数构造函数如果没有用explicit声明，则会成为隐式转换函数。 示例：

class Foo {
public:
    explicit Foo(const string& name): name_(name)
    {
    }
private:
    string name_;
};


void ProcessFoo(const Foo& foo){}

int main(void)
{
    std::string test = "test";
    ProcessFoo(test);  // 编译不通过
    return 0;
}

上面的代码编译不通过，因为ProcessFoo需要的参数是Foo类型，传入的string类型不匹配。

如果将Foo构造函数的explicit关键字移除，那么调用ProcessFoo传入的string就会触发隐式转换，生成一个临时的Foo对象。往往这种隐式转换是让人迷惑的，并且容易隐藏Bug，得到了一个不期望的类型转换。所以对于单参数的构造函数是要求explicit声明。

规则7.1.3 如果不需要拷贝构造函数、赋值操作符 / 移动构造函数、赋值操作符，请明确禁止

说明：如果用户不定义，编译器默认会生成拷贝构造函数和拷贝赋值操作符， 移动构造和移动赋值操作符（移动语义的函数C++11以后才有）。 如果我们不要使用拷贝构造函数，或者赋值操作符，请明确拒绝：

1. 将拷贝构造函数或者赋值操作符设置为private，并且不实现：

class Foo {
private:
    Foo(const Foo&);
    Foo& operator=(const Foo&);
};

2. 使用C++11提供的delete, 请参见后面现代C++的相关章节。

3. 推荐继承NoCopyable、NoMovable，禁止使用DISALLOW_COPY_AND_MOVE，DISALLOW_COPY，DISALLOW_MOVE等宏。

class Foo : public NoCopyable, public NoMovable {
};

NoCopyable和NoMovable的实现：

class NoCopyable {
public:
    NoCopyable() = default;
    NoCopyable(const NoCopyable&) = delete;
    NoCopyable& operator = (NoCopyable&) = delete;
};

class NoMovable {
public:
    NoMovable() = default;
    NoMovable(NoMovable&&) noexcept = delete;
    NoMovable& operator = (NoMovable&&) noexcept = delete;
};

规则7.1.4 拷贝构造和拷贝赋值操作符应该是成对出现或者禁止

拷贝构造函数和拷贝赋值操作符都是具有拷贝语义的，应该同时出现或者禁止。

// 同时出现
class Foo {
public:
    ...
    Foo(const Foo&);
    Foo& operator=(const Foo&);
    ...
};

// 同时default， C++11支持
class Foo {
public:
    Foo(const Foo&) = default;
    Foo& operator=(const Foo&) = default;
};

// 同时禁止, C++11可以使用delete
class Foo {
private:
    Foo(const Foo&);
    Foo& operator=(const Foo&);
};

规则7.1.5 移动构造和移动赋值操作符应该是成对出现或者禁止

在C++11中增加了move操作，如果需要某个类支持移动操作，那么需要实现移动构造和移动赋值操作符。

移动构造函数和移动赋值操作符都是具有移动语义的，应该同时出现或者禁止。

// 同时出现
class Foo {
public:
    ...
    Foo(Foo&&);
    Foo& operator=(Foo&&);
    ...
};

// 同时default， C++11支持
class Foo {
public:
    Foo(Foo&&) = default;
    Foo& operator=(Foo&&) = default;
};

// 同时禁止, 使用C++11的delete
class Foo {
public:
    Foo(Foo&&) = delete;
    Foo& operator=(Foo&&) = delete;
};

规则7.1.6 禁止在构造函数和析构函数中调用虚函数

说明：在构造函数和析构函数中调用当前对象的虚函数，会导致未实现多态的行为。 在C++中，一个基类一次只构造一个完整的对象。

示例：类Base是基类，Sub是派生类

class Base {                      
public:               
    Base();
    virtual void Log() = 0;    // 不同的派生类调用不同的日志文件
};

Base::Base()         // 基类构造函数
{
    Log();           // 调用虚函数Log
}                                                 

class Sub : public Base {      
public:
    virtual void Log();         
};

当执行如下语句： Sub sub; 会先执行Sub的构造函数，但首先调用Base的构造函数，由于Base的构造函数调用虚函数Log，此时Log还是基类的版本，只有基类构造完成后，才会完成派生类的构造，从而导致未实现多态的行为。 同样的道理也适用于析构函数。

规则7.1.7 多态基类中的拷贝构造函数、拷贝赋值操作符、移动构造函数、移动赋值操作符必须为非public函数或者为delete函数

如果报一个派生类对象直接赋值给基类对象，会发生切片，只拷贝或者移动了基类部分，损害了多态行为。 【反例】 如下代码中，基类没有定义拷贝构造函数或拷贝赋值操作符，编译器会自动生成这两个特殊成员函数， 如果派生类对象赋值给基类对象时就发生切片。可以将此例中的拷贝构造函数和拷贝赋值操作符声明为delete，编译器可检查出此类赋值行为。

class Base {                      
public:               
    Base() = default;
    virtual ~Base() = default;
    ...
    virtual void Fun() { std::cout << "Base" << std::endl;}
};

class Derived : public Base {
    ...
    void Fun() override { std::cout << "Derived" << std::endl; }
};

void Foo(const Base &base)
{
    Base other = base; // 不符合：发生切片
    other.Fun(); // 调用的时Base类的Fun函数
}

Derived d;
Foo(d); // 传入的是派生类对象

1. 将拷贝构造函数或者赋值操作符设置为private，并且不实现：

继承

规则7.2.1 基类的析构函数应该声明为virtual，不准备被继承的类需要声明为final

说明：只有基类析构函数是virtual，通过多态调用的时候才能保证派生类的析构函数被调用。

示例：基类的析构函数没有声明为virtual导致了内存泄漏。

class Base {
public:
```cpp
class Base {
public:
    virtual std::string getVersion() = 0;

    ~Base()
    {
        std::cout << "~Base" << std::endl;
    }
};

class Sub : public Base {
public:
    Sub() : numbers_(nullptr)
    { 
    }
   
    ~Sub()
    {
        delete[] numbers_;
        std::cout << "~Sub" << std::endl;
    }
   
    int Init()
    {
        const size_t numberCount = 100;
        numbers_ = new (std::nothrow) int[numberCount];
        if (numbers_ == nullptr) {
            return -1;
        }
       
        ...
    }

    std::string getVersion()
    {
        return std::string("hello!");
    }
private:
    int* numbers_;
};

int main(int argc, char* args[])
{
    Base* b = new Sub();

    delete b;
    return 0;
}

En raison de la fonction de destruction de la classe de base Base qui n’est pas déclarée virtuelle, lors de la destruction de l’objet, seule la fonction de destruction de la classe de base sera appelée, la fonction de destruction de la classe dérivée Sub ne sera pas appelée, ce qui entraînera une fuite de mémoire. Exception : Les classes NoCopyable et NoMovable qui n’ont aucun comportement, uniquement utilisées comme identifiants, peuvent ne pas définir de destructeur virtuel ni définir final.

Règle 7.2.2 Interdire l’utilisation de valeurs par défaut pour les fonctions virtuelles

Explication : En C++, les fonctions virtuelles sont liées dynamiquement, mais les paramètres par défaut de la fonction sont liés statiquement au moment de la compilation. Cela signifie que la fonction virtuelle finalement exécutée est définie dans la classe dérivée, mais utilise la valeur par défaut du paramètre de la classe de base. Pour éviter la confusion causée par les surcharges de fonctions virtuelles en raison de l’incohérence des déclarations de paramètres et les problèmes qui en découlent, il est interdit de déclarer des valeurs par défaut pour tous les paramètres des fonctions virtuelles. Exemple : Le paramètre par défaut text de la fonction virtuelle display est déterminé au moment de la compilation, pas au moment de l’exécution, ce qui ne permet pas d’atteindre l’objectif de la polymorphie :

class Base {
public:
    virtual void Display(const std::string& text = "Base!")
    {
        std::cout << text << std::endl;
    }
   
    virtual ~Base(){}
};

class Sub : public Base {
public:
    virtual void Display(const std::string& text  = "Sub!")
    {
        std::cout << text << std::endl;
    }
   
    virtual ~Sub(){}
};

int main()
{
    Base* base = new Sub();
    Sub* sub = new Sub();
  
    ...
   
    base->Display();  // Résultat du programme : Base! mais le résultat attendu : Sub!
    sub->Display();   // Résultat du programme : Sub!
   
    delete base;
    delete sub;
    return 0;
};

Règle 7.2.3 Interdire la redéfinition de fonctions non virtuelles héritées

Explication : Les fonctions non virtuelles ne peuvent pas réaliser la liaison dynamique, seules les fonctions virtuelles peuvent réaliser la liaison dynamique : il suffit d’opérer sur le pointeur de la classe de base pour obtenir le bon résultat.

Exemple :

class Base {
public:
    void Fun();
};

class Sub : public Base {
public:
    void Fun();
};

Sub* sub = new Sub();                    
Base* base = sub;

sub->Fun();    // Appelle la fonction Fun de la classe enfant                 
base->Fun();   // Appelle la fonction Fun de la classe parent
//...

Héritage multiple

Dans le développement réel, les scénarios d’utilisation de l’héritage multiple sont relativement rares, car l’héritage multiple a les problèmes typiques suivants lors de son utilisation :

1. L’héritage en forme de losange entraîne une duplication des données et une ambiguïté des noms. Par conséquent, C++ a introduit l’héritage virtuel pour résoudre ce type de problème ;
2. Même s’il ne s’agit pas d’un héritage en forme de losange, les noms de plusieurs classes parentes peuvent entrer en conflit, entraînant une ambiguïté ;
3. Lorsque la classe enfant doit étendre ou modifier les méthodes de plusieurs classes parentes, cela entraîne une responsabilité floue de la classe enfant et une sémantique confuse ;
4. Par rapport au délégation, l’héritage est un réemploi boîte blanche, c’est-à-dire que la classe enfant peut accéder aux membres protégés de la classe parente, ce qui entraîne un couplage plus fort. L’héritage multiple, en raison du couplage de plusieurs classes parentes, par rapport à l’héritage unique, crée une relation de couplage plus forte.

L’héritage multiple présente les avantages suivants : L’héritage multiple fournit un moyen plus simple de combiner pour réaliser l’assemblage et le réemploi de plusieurs interfaces ou classes.

Par conséquent, l’héritage multiple n’est autorisé que dans les cas suivants :

Recommandation 7.3.1 Utiliser l’héritage multiple pour réaliser la séparation des interfaces et la combinaison de rôles multiples

Si une certaine classe doit réaliser une interface multiple, elle peut utiliser l’héritage multiple pour combiner plusieurs interfaces séparées, similaire au mélange des traits du langage scala.

class Role1 {};
class Role2 {};
class Role3 {};

class Object1 : public Role1, public Role2 {
    // ...
};

class Object2 : public Role2, public Role3 {
    // ...
};

Il existe également des exemples similaires dans la bibliothèque standard C++ :

class basic_istream {};
class basic_ostream {};

class basic_iostream : public basic_istream, public basic_ostream {
 
};

Surcharge

La surcharge d’opérateurs doit avoir une raison suffisante, et ne doit pas changer la sémantique originale de l’opérateur, par exemple, ne pas utiliser l’opérateur ‘+’ pour faire des soustractions. La surcharge d’opérateurs rend le code plus intuitif, mais présente également certains inconvénients :

• Confondre l’intuition, en supposant que l’opération est aussi performante que le type intégré, en ignorant la possible diminution des performances ;
• Le dépannage n’est pas assez intuitif, la recherche par nom de fonction est évidemment plus pratique que par opérateur.
• Si le comportement de l’opérateur surchargé n’est pas intuitif (par exemple, utiliser l’opérateur ‘+’ pour faire des soustractions), cela peut entraîner une confusion du code.
• La surcharge de l’opérateur d’affectation introduit des conversions implicites qui peuvent cacher des bugs très profonds. On peut définir des fonctions comme Equals(), CopyFrom() etc. pour remplacer les opérateurs =, ==.

8 Fonctions

Conception de fonctions

Règle 8.1.1 Éviter les fonctions trop longues, les fonctions ne doivent pas dépasser 50 lignes (non vides, non commentaires)

Les fonctions doivent pouvoir être affichées sur un écran (moins de 50 lignes), ne faire qu’une seule chose et la faire correctement.

Les fonctions trop longues signifient souvent que la fonction n’est pas unique, trop complexe, ou trop détaillée, sans abstraction supplémentaire.

Exception : Certaines fonctions qui implémentent des algorithmes, en raison de l’aggrégation de l’algorithme et de la complétude de la fonction, peuvent dépasser 50 lignes.

Même si une longue fonction fonctionne très bien maintenant, une fois que quelqu’un la modifie, de nouveaux problèmes peuvent apparaître, voire entraîner des bugs difficiles à découvrir. Il est recommandé de la diviser en plusieurs fonctions plus courtes et plus faciles à gérer afin que d’autres puissent lire et modifier le code.

Fonctions inline

Recommandation 8.2.1 Les fonctions inline ne doivent pas dépasser 10 lignes (non vides, non commentaires)

Explication : Les fonctions inline ont les caractéristiques générales des fonctions, elles ne diffèrent des fonctions générales que par le traitement de l’appel de fonction. Lors de l’appel d’une fonction générale, il faut transférer le contrôle du programme à la fonction appelée, puis revenir à la fonction qui l’a appelée ; alors que lors de l’appel d’une fonction inline, l’expression d’appel est remplacée par le corps de la fonction inline.

Les fonctions inline conviennent uniquement aux petites fonctions de 1 à 10 lignes. Pour une grande fonction avec de nombreuses instructions, les coûts d’appel et de retour de fonction sont négligeables par rapport à la fonction, il n’est pas nécessaire d’utiliser une fonction inline, un compilateur général abandonnera la méthode inline et utilisera une méthode d’appel de fonction ordinaire.

Si la fonction inline contient des structures de contrôle complexes telles que des boucles, des branches (switch), des instructions try-catch, etc., le compilateur la traitera généralement comme une fonction ordinaire. Les fonctions virtuelles et récursives ne peuvent pas être utilisées comme fonctions inline.

Paramètres de fonction

Recommandation 8.3.1 Utiliser des références pour les paramètres de fonction au lieu de pointeurs

Explication : Les références sont plus sûres que les pointeurs, car elles ne peuvent pas être nulles et ne peuvent plus pointer vers d’autres cibles ; les références n’ont pas besoin de vérifier les pointeurs NULL illégaux.

Si le paramètre transmis est un tableau dont la longueur n’est pas connue à la compilation, on peut utiliser un pointeur au lieu d’une référence. Choisir const pour éviter que le paramètre ne soit modifié, permettant aux lecteurs de code de savoir clairement que ce paramètre ne sera pas modifié, ce qui peut grandement améliorer la lisibilité du code.

Exception : Lorsque le paramètre transmis est un tableau dont la longueur n’est pas connue à la compilation, on peut utiliser un pointeur au lieu d’une référence.

Recommandation 8.3.2 Utiliser des paramètres de type fort, éviter d’utiliser void*

Bien que différentes langues aient leurs propres points de vue sur les types forts et faibles, on considère généralement que c/c++ est un langage à typage fort, puisque le langage que nous utilisons est à typage fort, nous devrions maintenir ce style. L’avantage est de permettre au compilateur de détecter les incompatibilités de type lors de la phase de compilation.

L’utilisation de types forts permet au compilateur de nous aider à détecter les erreurs, comme le montre le code suivant concernant l’utilisation de la fonction FooListAddNode :

struct FooNode {
    struct List link;
    int foo;
};

struct BarNode {
    struct List link;
    int bar;
}

void FooListAddNode(void *node) // Bad: Using void * to pass parameters here
{
    FooNode *foo = (FooNode *)node;
    ListAppend(&g_FooList, &foo->link);
}

void MakeTheList()
{
    FooNode *foo = nullptr;
    BarNode *bar = nullptr;
    ...

    FooListAddNode(bar);        // Wrong: Here the intention was to pass foo, but accidentally passed bar, without any error
}

1. Les fonctions modèles peuvent être utilisées pour implémenter des changements de type de paramètres.
2. Les pointeurs de classe de base peuvent être utilisés pour réaliser le polymorphisme.

Recommandation 8.3.3 Le nombre de paramètres de fonction ne doit pas dépasser 5

Trop de paramètres de fonction rendent la fonction plus sensible aux changements externes, ce qui affecte le travail de maintenance. Trop de paramètres de fonction augmente également le travail de test.

Si cela dépasse la limite, envisagez :

• Voir si la fonction peut être divisée
• Voir si les paramètres connexes peuvent être regroupés, définir une structure

9 Autres caractéristiques de C++

Constantes et initialisation

Les valeurs immuables sont plus faciles à comprendre, à suivre et à analyser, donc les constantes devraient être utilisées autant que possible à la place des variables. Lors de la définition de valeurs, const devrait être la valeur par défaut.

Règle 9.1.1 Interdire l’utilisation de macros pour représenter des constantes

Explication : Les macros sont des remplacements de texte simples, terminés lors de la phase de prétraitement, les erreurs d’exécution affichent directement la valeur ; le suivi et le débogage affichent également la valeur, pas le nom de la macro ; les macros n’ont pas de vérification de type, ce qui n’est pas sécurisé ; les macros n’ont pas de portée.

#define MAX_MSISDN_LEN 20    // Pas bon

// C++ veuillez utiliser des constantes const
const int MAX_MSISDN_LEN = 20; // Bon

// Pour les versions C++11 et supérieures, constexpr peut être utilisé
constexpr int MAX_MSISDN_LEN = 20;

Recommandation 9.1.1 Un groupe de constantes entières connexes doivent être définies comme énumération

Explication : Les énumérations sont plus sûres que #define ou const int. Le compilateur vérifiera si la valeur du paramètre est dans la plage de valeurs de l’énumération, évitant ainsi les erreurs.

// Bon exemple :
enum Week {
    SUNDAY,
    MONDAY,
    TUESDAY,
    WEDNESDAY,
    THURSDAY,
    FRIDAY,
    SATURDAY
};

enum Color {
    RED,
    BLACK,
    BLUE
};

void ColorizeCalendar(Week today, Color color);

ColorizeCalendar(BLUE, SUNDAY); // Erreur de compilation, type de paramètre incorrect

// Mauvais exemple:
const int SUNDAY = 0;
const int MONDAY = 1;

const int BLACK  = 0;
const int BLUE   = 1;

bool ColorizeCalendar(int today, int color);
ColorizeCalendar(BLUE, SUNDAY); // Ne provoque pas d'erreur

Lorsque les valeurs énumérées doivent correspondre à des valeurs numériques spécifiques, elles doivent être explicitement assignées lors de la déclaration. Sinon, il n’est pas nécessaire de les assigner explicitement, afin d’éviter les assignations répétées et de réduire la charge de maintenance (ajout, suppression de membres).

// Bon exemple : Les valeurs ID d'appareil définies dans le protocole S, utilisées pour identifier le type d'appareil
enum DeviceType {
    DEV_UNKNOWN = -1,
    DEV_DSMP = 0,
    DEV_ISMG = 1,
    DEV_WAPPORTAL = 2
};

Pour une utilisation interne au programme, uniquement pour la classification, les valeurs énumérées ne doivent pas être explicitement assignées.

// Bon exemple : Définition de l'énumération utilisée dans le programme pour identifier l'état de la session
enum SessionState {
    INIT,
    CLOSED,
    WAITING_FOR_RESPONSE
};

Nous devrions éviter autant que possible les doublons de valeurs énumérées, et si cela est nécessaire, il faut utiliser une énumération déjà définie pour la modifier.

enum RTCPType {
    RTCP_SR = 200,
    RTCP_MIN_TYPE = RTCP_SR,       
    RTCP_RR    = 201,
    RTCP_SDES  = 202,
    RTCP_BYE   = 203,
    RTCP_APP   = 204,
    RTCP_RTPFB = 205,
    RTCP_PSFB  = 206,
    RTCP_XR  = 207,
    RTCP_RSI = 208,
    RTCP_PUBPORTS = 209,
    RTCP_MAX_TYPE = RTCP_PUBPORTS 
};

Règle 9.1.2 Interdire l’utilisation de nombres diaboliques

Les nombres diaboliques sont des nombres incompréhensibles et difficiles à comprendre.

Les nombres diaboliques ne sont pas un concept noir ou blanc, et le degré de non-compréhension varie, il faut juger soi-même. Par exemple, le nombre 12, dans différents contextes, la situation est différente : type = 12; est incompréhensible, mais monthsCount = yearsCount * 12; est compréhensible. Le nombre 0 est parfois aussi un nombre diabolique, comme status = 0; ne peut pas exprimer quel état.

Solutions : Pour les nombres utilisés localement, des commentaires peuvent être ajoutés pour expliquer Pour les nombres utilisés à plusieurs endroits, const doit être défini comme constante et le symbole doit être auto-commenté via le nom du symbole.

Interdiction d’apparition des situations suivantes : Pas d’explication du sens des nombres par symbole, comme const int ZERO = 0 Le nom du symbole limite sa valeur, comme const int XX_TIMER_INTERVAL_300MS = 300, utilisez directement XX_TIMER_INTERVAL_MS pour indiquer que cette constante est l’intervalle de temps du minuteur.

Règle 9.1.3 Les constantes doivent garantir une responsabilité unique

Explication : Une constante ne doit représenter qu’une fonction spécifique, c’est-à-dire qu’une constante ne doit pas avoir plusieurs usages.

// Bon exemple : Protocoles A et B, la longueur du numéro MSISDN est de 20.
const unsigned int A_MAX_MSISDN_LEN = 20;
const unsigned int B_MAX_MSISDN_LEN = 20;

// Ou utilisez des espaces de noms différents :
namespace Namespace1 {
    const unsigned int MAX_MSISDN_LEN = 20;
}

namespace Namespace2 {
    const unsigned int MAX_MSISDN_LEN = 20;
}

Règle 9.1.4 Interdire l’utilisation de memcpy_s, memset_s pour initialiser les objets non-POD

Explication : POD est l’acronyme de Plain Old Data, un concept introduit dans la norme C++ 98 (ISO/IEC 14882, première édition, 1998-09-01). Les types POD incluent principalement int, char, float, double, enumeration, void, pointeurs et autres types primitifs ainsi que les types agrégés. Ils ne peuvent pas utiliser l’encapsulation et les caractéristiques orientées objet (comme les constructeurs/destructeurs/assignateurs définis par l’utilisateur, les classes de base, les fonctions virtuelles, etc.).

Étant donné que les objets non-POD, tels que les objets de type classe non agrégée, peuvent contenir des fonctions virtuelles, la disposition mémoire n’est pas définie et dépend du compilateur. Une utilisation abusive de la copie mémoire peut entraîner de graves problèmes.

Même pour les objets de type classe agrégée, l’utilisation directe de la copie mémoire et de la comparaison ne respecte pas le principe de dissimulation d’information et de protection des données, et il n’est donc pas recommandé d’utiliser les opérations memcpy_s, memset_s.

Pour plus de détails sur les types POD, voir l’annexe.

Recommandation 9.1.2 Déclarer et initialiser les variables lorsqu’elles sont utilisées

Explication : Ne pas initialiser les variables avant de les utiliser est une erreur de programmation basique fréquente. Déclarer les variables lorsqu’elles sont utilisées et les initialiser en même temps évite très facilement ce type d’erreur basique.

Déclarer toutes les variables au début de la fonction, puis les utiliser plus tard, avec une portée couvrant toute la fonction, peut facilement entraîner les problèmes suivants :

• Le programme est difficile à comprendre et à maintenir : la déclaration et l’utilisation des variables sont séparées.
• Les variables sont difficiles à initialiser correctement : au début de la fonction, il n’y a souvent pas assez d’informations pour initialiser les variables, on utilise souvent une certaine valeur par défaut vide (comme zéro) pour initialiser, ce qui est souvent une perte de temps. Si la variable est utilisée avant d’être attribuée une valeur valide, cela peut entraîner des erreurs.

En suivant le principe de portée minimale et de déclaration rapprochée des variables, il est plus facile de comprendre le type et la valeur initiale des variables. En particulier, l’initialisation doit remplacer l’assignation après déclaration.

// Mauvais exemple : déclaration et initialisation séparées
string name;        // Non initialisé lors de la déclaration : appel du constructeur par défaut
name = "zhangsan";  // Appel à nouveau de l'opérateur d'assignation ; déclaration et définition à des endroits différents, difficile à comprendre

// Bon exemple : déclaration et initialisation combinées, plus facile à comprendre
string name("zhangsan");  // Appel du constructeur

Expressions

Règle 9.2.1 Interdire de faire référence à nouveau à la variable dans une expression contenant une opération d’auto-incrémentation ou de décrémentation

Dans les expressions contenant des opérations d’auto-incrémentation ou de décrémentation, si la variable est référencée à nouveau, le résultat n’est pas clairement défini dans la norme C++. Les implémentations des différents compilateurs ou des différentes versions du même compilateur peuvent être incohérentes. Pour une meilleure portabilité, aucune hypothèse ne doit être faite sur l’ordre d’opération non défini par la norme.

Notez que les problèmes d’ordre d’opération ne peuvent pas être résolus en utilisant des parenthèses, car ce n’est pas une question de priorité.

Exemple :

x = b[i] + i++; // Bad: b[i] l'ordre de calcul et i++ n'est pas clair.

La manière correcte d’écrire est de mettre l’incrémentation ou la décrémentation sur une ligne séparée :

x = b[i] + i;
i++;            // Good: sur une ligne séparée

Paramètres de fonction

Func(i++, i);   // Bad: lors du passage du deuxième paramètre, il n'est pas clair si l'opération d'incrémentation a eu lieu

Écriture correcte

i++;            // Good: sur une ligne séparée
x = Func(i, i);

Règle 9.2.2 Les instructions switch doivent avoir une branche default

Dans la plupart des cas, les instructions switch doivent avoir une branche default pour garantir un traitement par défaut lorsqu’une balise case est oubliée, évitant ainsi les problèmes.

Exception : Si la variable de condition du switch est de type énuméré et que les branches case couvrent toutes les valeurs, l’ajout d’une branche default pour le traitement est un peu superflu. Les compilateurs modernes ont la capacité de vérifier si certaines valeurs d’énumération sont oubliées dans les branches case de l’instruction switch, et il y aura un avertissement correspondant.

enum Color {
    RED = 0,
    BLUE
};

// Parce que la variable de condition du switch est une énumération, il n'est pas nécessaire d'ajouter une branche de traitement default ici
switch (color) {
    case RED:
        DoRedThing();
        break;
    case BLUE:
        DoBlueThing();
        ...
        break;
}

Recommandation 9.2.1 Lors de la comparaison dans les expressions, on doit suivre le principe de laisser le côté gauche tendre vers le changement et le côté droit tendre vers l’invariabilité

Lorsque les variables sont comparées aux constantes, si la constante est à gauche, comme if (MAX == v) ne correspond pas à l’habitude de lecture, alors que if (MAX > v) est encore plus difficile à comprendre. Il faut suivre l’habitude normale de lecture et d’expression des gens, et placer la constante à droite. Écrivez comme suit :

if (value == MAX) {
 
}

if (value < MAX) {
 
}

Il y a aussi des cas particuliers, comme :if (MIN < value && value < MAX) pour décrire un intervalle, la première moitié a la constante à gauche.

Ne vous inquiétez pas de confondre ‘==’ avec ‘=’, car if (value = MAX) aura un avertissement de compilation, d’autres outils de vérification statique afficheront également des erreurs. Laissez les outils résoudre les problèmes de fautes de frappe, le code doit être prioritaire pour la lisibilité.

Recommandation 9.2.2 Utiliser des parenthèses pour clarifier la priorité des opérateurs

Utilisez des parenthèses pour clarifier la priorité des opérateurs, afin d’éviter que la priorité par défaut ne soit conforme à la conception et ne provoque des erreurs de programme ; en même temps, cela rend le code plus clair et lisible, cependant, trop de parenthèses disperseront le code et réduiront sa lisibilité. Voici quelques suggestions sur l’utilisation des parenthèses.

• Pour les opérateurs binaires et plus, si plusieurs opérateurs sont impliqués, des parenthèses doivent être utilisées

x = a + b + c;         /* Les opérateurs sont les mêmes, les parenthèses ne sont pas nécessaires */
x = Foo(a + b, c);     /* Les expressions de chaque côté de la virgule n'ont pas besoin de parenthèses */
x = 1 << (2 + 3);      /* Les opérateurs sont différents, les parenthèses sont nécessaires */
x = a + (b / 5);       /* Les opérateurs sont différents, les parenthèses sont nécessaires */
x = (a == b) ? a : (a – b);    /* Les opérateurs sont différents, les parenthèses sont nécessaires */

Conversion de type

Évitez d’utiliser des branches de type pour personnaliser le comportement : l’utilisation de branches de type pour personnaliser le comportement est facile à faire des erreurs, c’est un signe évident de l’écriture de code C avec C++. C’est une technique très inflexible, lors de l’ajout de nouveaux types, si vous oubliez de modifier toutes les branches, le compilateur ne vous le dira pas. Utilisez des modèles et des fonctions virtuelles, laissez le type lui-même, et non le code qui les appelle, décider du comportement. Évitez autant que possible la conversion de type, nous devrions envisager le type de données de chaque donnée lors de la conception du type de données de notre code, plutôt que de trop dépendre de la conversion de type pour résoudre les problèmes. Lors de la conception d’un type de base, veuillez considérer :

• Est-ce signé ou non signé
• Convient-il mieux à float ou à double
• Est-ce que int8, int16, int32 ou int64 conviennent, déterminez la longueur de l’entier

Cependant, nous ne pouvons pas interdire l’utilisation de la conversion de type, car le C++ est un langage de programmation orienté machine, impliquant des pointeurs et des adresses, et nous interagissons avec diverses API tierces ou de bas niveau, leurs conceptions de types ne sont pas toujours raisonnables, et lors de l’adaptation de ce processus, il est facile d’apparaître des conversions de type.

Exception : Lors de l’appel d’une fonction, si nous ne voulons pas traiter le résultat de la fonction, nous devrions d’abord envisager si c’est notre meilleur choix. Si nous ne voulons vraiment pas traiter la valeur de retour de la fonction, alors nous pouvons utiliser la conversion (void) pour résoudre cela.

Règle 9.3.1 Si vous êtes sûr d’utiliser la conversion de type, veuillez utiliser la conversion de type fournie par C++, plutôt que le style C de conversion de type

Explication :

Les opérations de conversion de type fournies par C++ sont plus ciblées et plus sûres que celles du style C, et plus faciles à lire. Les conversions fournies par C++ sont :

• Conversion de type :

1. dynamic_cast : principalement utilisé pour la conversion descendante dans la hiérarchie d’héritage, dynamic_cast a la fonction de vérification de type, veuillez bien concevoir vos classes de base et dérivées, et évitez d’utiliser dynamic_cast pour la conversion.
2. static_cast : similaire à la conversion de style C, peut effectuer des conversions de valeurs forcées, ou des conversions ascendantes (convertir un pointeur ou une référence dérivée en pointeur ou référence de base). Cette conversion est souvent utilisée pour éliminer l’ambiguïté de type apportée par l’héritage multiple, ce qui est relativement sûr. Si c’est une simple conversion arithmétique, veuillez utiliser la méthode d’initialisation avec accolades plus tard.
3. reinterpret_cast : utilisé pour convertir des types non liés. reinterpret_cast force le compilateur à réinterpréter la mémoire d’un type d’objet en un autre type, ce qui est une conversion non sûre, il est recommandé d’éviter autant que possible l’utilisation de reinterpret_cast.
4. const_cast : utilisé pour supprimer la propriété const d’un objet, rendant l’objet modifiable, ce qui détruit l’invariabilité des données, il est recommandé d’éviter autant que possible.

• Conversion arithmétique : (supportée depuis C++11) Pour ce type de conversion arithmétique, et pour celles où l’information de type n’est pas perdue, comme la conversion de float à double, int32 à int64, il est recommandé d’utiliser la méthode d’initialisation avec accolades.

  double d{ someFloat };
  int64_t i{ someInt32 };

Recommandation 9.3.1 Éviter d’utiliser dynamic_cast

1. dynamic_cast dépend du RTTI de C++, permettant aux programmeurs d’identifier le type d’objet C++ au moment de l’exécution.
2. L’apparition de dynamic_cast indique généralement que notre conception de classe de base et de classe dérivée a des problèmes, la classe dérivée viole le contrat de la classe de base, il faut absolument convertir en classe dérivée via dynamic_cast pour un traitement particulier, à ce moment-là, il est préférable d’améliorer la conception de la classe plutôt que de résoudre le problème avec dynamic_cast.

Recommandation 9.3.2 Éviter d’utiliser reinterpret_cast

Explication : reinterpret_cast est utilisé pour convertir des types non liés. Essayer d’utiliser reinterpret_cast pour forcer le type d’une chose à être converti en un autre type, cela viole la sécurité et la fiabilité du type, c’est une conversion non sûre. Évitez autant que possible la conversion entre différents types.

Recommandation 9.3.3 Éviter d’utiliser const_cast

Explication : const_cast est utilisé pour supprimer les propriétés const et volatile d’un objet.

Modifier un objet const via un pointeur ou une référence obtenu par const_cast est un comportement indéfini.

// Mauvais exemple
const int i = 1024;
int* p = const_cast<int*>(&i);
*p = 2048;      // Comportement indéfini

// Mauvais exemple
class Foo {
public:
    Foo() : i(3) {}

    void Fun(int v)
    {
        i = v;
    }

private:
    int i;
};

int main(void)
{
    const Foo f;
    Foo* p = const_cast<Foo*>(&f);
    p->Fun(8);  // Comportement indéfini
}

Allocation et libération de ressources

Règle 9.4.1 Libérer un seul objet avec delete, libérer un tableau d’objets avec delete []

Explication : la suppression d’un seul objet utilise delete, la suppression d’un tableau d’objets utilise delete [], raison :

• L’action d’appeler new : demander un bloc de mémoire au système, et appeler le constructeur de ce type.
• L’action d’appeler new[n] : demander de la mémoire pouvant contenir n objets, et appeler le constructeur de chaque objet.
• L’action d’appeler delete : appeler d’abord le destructeur correspondant, puis retourner la mémoire au système.
• L’action d’appeler delete[] : appeler le destructeur de chaque objet, puis libérer toute la mémoire

Si le format de new et delete ne correspond pas, le résultat est inconnu. Pour les types non-class, new et delete n’appellent pas de constructeur et de destructeur.

Mauvaise écriture :

const int MAX_ARRAY_SIZE = 100;
int* numberArray = new int[MAX_ARRAY_SIZE];
...
delete numberArray;
numberArray = nullptr;

Bonne écriture :

const int MAX_ARRAY_SIZE = 100;
int* numberArray = new int[MAX_ARRAY_SIZE];
...
delete[] numberArray;
numberArray = nullptr;

Recommandation 9.4.1 Utiliser la caractéristique RAII pour aider à suivre l’allocation dynamique

Explication : RAII est l’abréviation de “Resource Acquisition Is Initialization” (l’acquisition de ressources est l’initialisation), c’est une technique simple qui utilise le cycle de vie d’un objet pour contrôler les ressources du programme (comme la mémoire, les descripteurs de fichiers, les connexions réseau, les mutex, etc.).

La pratique générale de RAII est la suivante : lors de la construction d’un objet, acquérir des ressources, puis contrôler l’accès aux ressources afin qu’elles restent valides tout au long du cycle de vie de l’objet, et enfin libérer les ressources lors de la destruction de l’objet. Cette pratique a deux grands avantages :

• Nous n’avons pas besoin de libérer explicitement les ressources.
• Les ressources nécessaires à l’objet restent toujours valides tout au long de leur cycle de vie. De cette façon, il n’est pas nécessaire de vérifier la validité des ressources, ce qui peut simplifier la logique et améliorer l’efficacité.

Exemple : l’utilisation de RAII ne nécessite pas de libérer explicitement les ressources mutex.

class LockGuard {
public:
    LockGuard(const LockType& lockType): lock_(lockType)
    {
        lock_.Acquire();
    }
   
    ~LockGuard()
    {
        lock_.Release();
    }
   
private:
    LockType lock_;
};


bool Update()
{
    LockGuard lockGuard(mutex);
    if (...) {
        return false;
    } else {
        // Manipuler les données
    }
   
    return true;
}

Bibliothèque standard

Le degré d’utilisation de STL dans différents produits varie, voici quelques règles et recommandations de base pour référence par les équipes.

Règle 9.5.1 Ne pas conserver le pointeur retourné par c_str() de std::string

Explication : Dans la norme C++, il n’est pas précisé que le pointeur retourné par string::c_str() doit être durablement valide, par conséquent, une implémentation particulière de STL peut parfaitement retourner un stockage temporaire lors de l’appel de string::c_str() et le libérer rapidement. Ainsi, pour garantir la portabilité du programme, ne conservez pas le résultat de string::c_str(), mais appelez-le directement chaque fois que vous en avez besoin.

Exemple :

void Fun1()
{
    std::string name = "demo";
    const char* text = name.c_str();  // Après la fin de l'expression, le cycle de vie de name continue, le pointeur est valide

    // Si une fonction membre non const de string est appelée au milieu, entraînant une modification de string, comme operator[], begin() etc.
    // Peut entraîner l'invalidité du contenu du pointeur text, ou que ce ne soit plus la chaîne d'origine
    name = "test";
    name[1] = '2';

    // Utilisation ultérieure du pointeur text, son contenu n'est plus la chaîne "demo"
}

void Fun2()
{
    std::string name = "demo";
    std::string test = "test";
    const char* text = (name + test).c_str(); // Après la fin de l'expression, l'objet temporaire généré par + est détruit, le pointeur est invalide

    // Utilisation ultérieure du pointeur text, il ne pointe plus vers un espace mémoire légal
}

Exception : Dans quelques codes très exigeants en termes de performance, afin de s’adapter aux fonctions existantes qui n’acceptent que le type const char*, il est possible de conserver temporairement le pointeur retourné par string::c_str(). Mais il faut absolument garantir que le cycle de vie de l’objet string est plus long que celui du pointeur conservé, et garantir que pendant la durée de vie du pointeur conservé, l’objet string ne sera pas modifié.

Recommandation 9.5.1 Utiliser std::string à la place de char*

Explication : L’utilisation de string à la place de char* présente de nombreux avantages, tels que :

1. Pas besoin de se soucier du ‘\0’ de fin ;
2. Peut directement utiliser les opérateurs +, =, == et d’autres fonctions d’opérations sur les chaînes ;
3. Pas besoin de se soucier de l’allocation mémoire, évitant le new/delete explicite et les erreurs qui en découlent ;

Il convient de noter que certaines implémentations de STL string utilisent une stratégie de copie à l’écriture, ce qui entraîne deux problèmes : premièrement, certaines versions de la stratégie de copie à l’écriture n’ont pas implémenté la sécurité des threads, ce qui peut entraîner l’effondrement du programme dans un environnement multi-thread ; deuxièmement, lors du passage de string basé sur la stratégie de copie à l’écriture entre des bibliothèques dynamiques, le comptage de références ne peut pas être réduit lors du déchargement de la bibliothèque dynamique, ce qui peut entraîner un pointeur suspendu. Par conséquent, le choix d’une implémentation STL fiable est très important pour assurer la stabilité du programme.

Exception : Lors de l’appel de l’API du système ou d’autres bibliothèques tierces, pour les interfaces déjà définies, seule la char* peut être utilisée. Cependant, avant d’appeler l’interface, string peut être utilisé, et lors de l’appel de l’interface, string::c_str() peut être utilisé pour obtenir le pointeur de caractères. Lorsqu’un tableau de caractères est alloué sur la pile pour être utilisé comme tampon, le tableau de caractères peut être défini directement, sans utiliser string, et il n’est pas nécessaire d’utiliser des conteneurs tels que vector<char>.

Règle 9.5.2 Interdire l’utilisation de auto_ptr

Explication : Dans la bibliothèque stl, std::auto_ptr possède un comportement de transfert implicite de propriété, comme le montre le code suivant :

auto_ptr<T> p1(new T);
auto_ptr<T> p2 = p1;

Après l’exécution de la deuxième ligne d’instruction, p1 ne pointe plus vers l’objet alloué à la première ligne, mais devient nullptr. C’est précisément à cause de cela que auto_ptr ne peut pas être placé dans divers conteneurs standards. Le comportement de transfert de propriété est souvent le résultat non souhaité. Pour les scénarios où il est absolument nécessaire de transférer la propriété, l’utilisation d’une méthode de transfert implicite n’est pas non plus recommandée. Cela nécessite souvent une vigilance supplémentaire de la part des programmeurs sur le code utilisant auto_ptr, sinon des accès à des pointeurs nuls peuvent survenir. Il existe deux scénarios courants pour l’utilisation d’auto_ptr, l’un est d’utiliser auto_ptr comme pointeur intelligent transmis à l’extérieur de la fonction générant auto_ptr, et l’autre est d’utiliser auto_ptr comme classe de gestion RAII pour libérer automatiquement les ressources lorsqu’elle sort de son cycle de vie. Pour le premier scénario, std::shared_ptr peut être utilisé à la place. Pour le deuxième scénario, std::unique_ptr de la norme C++11 peut être utilisé à la place. std::unique_ptr est le successeur de std::auto_ptr, prenant en charge le transfert explicite de propriété.

Exception : Avant que la norme C++11 ne soit largement utilisée, dans les scénarios où il est absolument nécessaire de transférer la propriété, std::auto_ptr peut être utilisé, mais il est recommandé d’encapsuler std::auto_ptr et d’interdire le constructeur de copie et l’opérateur d’affectation de la classe d’encapsulation, afin que cette classe d’encapsulation ne puisse pas être utilisée dans les conteneurs standards.

Recommandation 9.5.2 Utiliser les nouveaux en-têtes standards

Explication : Lors de l’utilisation des en-têtes standards C++, veuillez utiliser <cstdlib> plutôt que <stdlib.h>.

Utilisation de const

Ajouter le mot-clé const devant les variables ou les paramètres déclarés indique que la valeur de la variable ne peut pas être altérée (par exemple const int foo). Ajouter le qualificatif const aux fonctions de classe indique que la fonction ne modifiera pas l’état des variables membres de la classe (par exemple class Foo { int Bar(char c) const; };). Les variables const, les membres de données, les fonctions et les paramètres ajoutent une couche de protection pour la détection des types au moment de la compilation, facilitant ainsi la détection précoce des erreurs. Par conséquent, nous recommandons fortement d’utiliser const dans toutes les situations possibles. Parfois, il peut être préférable d’utiliser constexpr de C++11 pour définir de véritables constantes.

Règle 9.6.1 Pour les paramètres de pointeur et de référence, si aucune modification n’est requise, utilisez const

Les valeurs immuables sont plus faciles à comprendre/suivre et à analyser, en faisant const la valeur par défaut, ce qui est vérifié au moment de la compilation, rendant le code plus robuste/sûr.

class Foo;

void PrintFoo(const Foo& foo);

Règle 9.6.2 Pour les fonctions membres qui ne modifient pas les variables membres, utilisez const

Déclarez autant que possible les fonctions membres comme const. Les fonctions d’accès devraient toujours être const. Toutes les fonctions membres qui ne modifient pas les données membres doivent être déclarées comme const. Pour les fonctions virtuelles, il faut envisager la conception de la chaîne d’héritage pour déterminer si toutes les classes ont besoin de modifier les données membres dans cette fonction virtuelle, plutôt que de se concentrer uniquement sur l’implémentation d’une seule classe.

class Foo {
public:

    // ...

    int PrintValue() const // const modifie la fonction membre, ne modifie pas les variables membres
    {
        std::cout << value_ << std::endl;
    }

    int GetValue() const  // const modifie la fonction membre, ne modifie pas les variables membres
    {
        return value_;
    }

private:
    int value_;
};

Recommandation 9.6.1 Définir les variables membres comme const si elles ne sont pas modifiées après l’initialisation

class Foo {
public:
    Foo(int length) : dataLength_(length) {}
private:
    const int dataLength_; 
};

Exceptions

Recommandation 9.7.1 En C++11, si une fonction ne lève pas d’exception, déclarez-la comme noexcept

Raison

1. Si la fonction ne lève pas d’exception, la déclarer comme noexcept permet au compilateur d’optimiser la fonction au maximum, comme réduire les chemins d’exécution, améliorer l’efficacité de la sortie d’erreur.
2. STL conteneurs comme vector, pour garantir la robustesse de l’interface, si le move operator de l’élément stocké n’est pas déclaré comme noexcept, lors de l’expansion du conteneur pour déplacer les éléments, il n’utilisera pas le mécanisme move, mais utilisera le mécanisme copy, ce qui entraîne un risque de perte de performance. Si une fonction ne peut pas lever d’exception, ou si un programme n’intercepte pas l’exception levée par une fonction et ne la traite pas, alors cette fonction peut être décorée avec le nouveau mot-clé noexcept pour indiquer que cette fonction ne lève pas d’exception ou que l’exception levée ne sera pas interceptée et traitée. Par exemple :

extern "C" double sqrt(double) noexcept;  // Ne lèvera jamais d'exception

// Même si une exception peut être levée, noexcept peut également être utilisé
// Ici, nous ne prévoyons pas de traiter l'exception d'épuisement de mémoire, en déclarant simplement la fonction comme noexcept
std::vector<int> MyComputation(const std::vector<int>& v) noexcept
{
    std::vector<int> res = v;    // Peut lever une exception
    // faire quelque chose
    return res;
}

Exemple

RetType Function(Type params) noexcept;   // Optimisation maximale
RetType Function(Type params);            // Moins d'optimisation

// Le move operation de std::vector nécessite une déclaration noexcept
class Foo1 {
public:
    Foo1(Foo1&& other);  // no noexcept
};

std::vector<Foo1> a1;
a1.push_back(Foo1());
a1.push_back(Foo1());  // Déclenche l'expansion du conteneur, appelle le constructeur de copie lors du déplacement des éléments existants

class Foo2 {
public:
    Foo2(Foo2&& other) noexcept;
};

std::vector<Foo2> a2;
a2.push_back(Foo2());
a2.push_back(Foo2());  // Déclenche l'expansion du conteneur, appelle le constructeur de move lors du déplacement des éléments existants

Note Les constructeurs par défaut, les destructeurs, les fonctions swap et les opérateurs move ne devraient pas lever d’exception.

Modèles et programmation générique

Règle 9.8.1 Interdire la programmation générique dans les projets OpenHarmony

La programmation générique et la programmation orientée objet ont des idées, des concepts et des techniques complètement différents, le projet OpenHarmony utilise principalement l’idée de programmation orientée objet.

C++ fournit un mécanisme de programmation générique puissant, capable de réaliser des interfaces très flexibles et concises, sûres au niveau du type, et de réutiliser le code avec des comportements différents mais des types identiques.

Cependant, la programmation générique en C++ présente les inconvénients suivants :

1. Les personnes pas très familières avec la programmation générique ont souvent tendance à écrire des modèles pour la logique orientée objet, à écrire des membres indépendants des paramètres de modèle dans les modèles, etc., ce qui entraîne une confusion logique et un gonflement du code.
2. La programmation avec modèles utilise souvent des techniques obscures pour les personnes pas très familières avec C++. Le code écrit avec des modèles dans des endroits complexes est souvent plus difficile à comprendre, et le débogage et la maintenance sont très compliqués.
3. La programmation avec modèles entraîne souvent des messages d’erreur de compilation très peu amicaux : lorsqu’il y a une erreur dans le code, même si l’interface est très simple, les détails d’implémentation complexes du modèle apparaissent dans le message d’erreur, rendant ce message très difficile à comprendre.
4. Une mauvaise utilisation des modèles peut entraîner un gonflement excessif du code au moment de l’exécution.
5. Le code avec modèles est difficile à modifier et à refactoriser. Le code avec modèles s’étend dans de nombreux contextes, il est donc difficile de confirmer que le refactorisation est utile pour toutes ces extensions de code.

Par conséquent, la plupart des composants d’OpenHarmony interdisent la programmation avec modèles, seuls quelques composants peuvent utiliser la programmation générique, et le code avec modèles développé doit être accompagné de commentaires détaillés. Exception :

1. La couche d’adaptation stl peut utiliser des modèles

Macros

Dans le langage C++, nous recommandons fortement d’utiliser le moins possible les macros complexes

• Pour la définition de constantes, veuillez suivre les principes décrits dans les chapitres précédents, en utilisant const ou enum ;
• Pour les fonctions macros, essayez de les rendre aussi simples que possible, et suivez les principes décrits ci-dessous, et privilégiez les fonctions inline, les fonctions templates, etc. pour les remplacer.

// Déconseillé d'utiliser les fonctions macros
#define SQUARE(a, b) ((a) * (b))

// Veuillez utiliser les fonctions templates, les fonctions inline, etc. pour les remplacer.
template<typename T> T Square(T a, T b) { return a * b; }

Si vous devez utiliser des macros, veuillez vous référer aux chapitres correspondants de la norme C. Exception : Certaines applications générales et matures, comme le traitement d’encapsulation des new, delete, peuvent conserver l’utilisation des macros.

10 Caractéristiques modernes de C++

Avec la publication de la norme C++11 par l’ISO en 2011, puis C++17 en mars 2017, le C++ moderne (C++11/14/17, etc.) a ajouté de nombreuses nouvelles caractéristiques linguistiques et bibliothèques standard pour améliorer l’efficacité de programmation et la qualité du code. Ce chapitre décrit quelques directives qui peuvent aider les équipes à utiliser le C++ moderne plus efficacement et à éviter les pièges linguistiques.

Amélioration de la concision et de la sécurité du code

Recommandation 10.1.1 Utiliser auto de manière raisonnable

Raison

• auto peut éviter d’écrire des noms de type longs et répétitifs, et peut garantir l’initialisation de la variable lors de sa définition.
• Les règles de déduction de type auto sont complexes, il faut les comprendre attentivement.
• Si cela peut rendre le code plus clair, continuez à utiliser le type explicite, et n’utilisez auto que pour les variables locales.

Exemple

// Éviter les noms de type longs
std::map<string, int>::iterator iter = m.find(val);
auto iter = m.find(val);

// Éviter la répétition du nom de type
class Foo {...};
Foo* p = new Foo;
auto p = new Foo;

// Garantir l'initialisation
int x;    // Compilation réussie, pas d'initialisation
auto x;   // Échec de compilation, doit être initialisé

Le type déduit par auto peut entraîner de la confusion :

auto a = 3;           // int
const auto ca = a;    // const int
const auto& ra = a;   // const int&
auto aa = ca;         // int, ignore const et reference
auto ila1 = { 10 };   // std::initializer_list<int>
auto ila2{ 10 };      // std::initializer_list<int>

auto&& ura1 = x;      // int&
auto&& ura2 = ca;     // const int&
auto&& ura3 = 10;     // int&&

const int b[10];
auto arr1 = b;        // const int*
auto& arr2 = b;       // const int(&)[10]

Si l’on ne fait pas attention à l’ignorance de la référence par auto lors de la déduction de type, cela peut introduire des problèmes de performance difficiles à détecter :

std::vector<std::string> v;
auto s1 = v[0];  // auto est déduit comme std::string, copie v[0]

Si auto est utilisé pour définir une interface, comme une constante dans un fichier d’en-tête, il se peut que le type change à cause de la modification de la valeur par le développeur.

Règle 10.1.1 Lors de la surcharge d’une fonction virtuelle, utilisez les mots-clés override ou final

Raison Les mots-clés override et final garantissent que la fonction est virtuelle et qu’elle redéfinit la fonction virtuelle de la classe de base. Si le prototype de la fonction enfant est incohérent avec la fonction de base, une alerte de compilation se produit. final garantit également que la fonction virtuelle ne sera pas redéfinie par la classe enfant.

En utilisant les mots-clés override ou final, si le prototype de la fonction virtuelle de base est modifié mais que la fonction virtuelle redéfinie de la classe enfant est oubliée, cela peut être détecté lors de la compilation. Cela peut également éviter l’oubli de la redéfinition de la fonction virtuelle lorsqu’il y a plusieurs classes enfants.

Exemple

class Base {
public:
    virtual void Foo();
    virtual void Foo(int var);
    void Bar();
};

class Derived : public Base {
public:
    void Foo() const override; // Échec de compilation: le prototype de Derived::Foo et Base::Foo sont incohérents, ce n'est pas une redéfinition
    void Foo() override;       // Correct: Derived::Foo redéfinit Base::Foo
    void Foo(int var) final;   // Correct: Derived::Foo(int) redéfinit Base::Foo(int) et les classes dérivées de Derived ne peuvent plus redéfinir cette fonction
    void Bar() override;       // Échec de compilation: Base::Bar n'est pas une fonction virtuelle
};

Résumé

1. Lorsque la classe de base définit pour la première fois une fonction virtuelle, utilisez le mot-clé virtual
2. Lorsque la classe enfant redéfinit une fonction virtuelle de la classe de base (y compris le destructeur), utilisez les mots-clés override ou final (mais pas les deux en même temps), et n’utilisez pas le mot-clé virtual
3. Pour les fonctions non virtuelles, n’utilisez pas les mots-clés virtual, override et final

Règle 10.1.2 Utiliser le mot-clé delete pour supprimer les fonctions

Raison Par rapport à la déclaration de fonctions membres de classe comme private mais non implémentées, le mot-clé delete est plus explicite et a une portée d’application plus large.

Exemple

class Foo {
private:
    // On ne peut pas savoir en regardant l'en-tête si le constructeur de copie est supprimé
    Foo(const Foo&);
};

class Foo {
public:
    // Supprimer explicitement la fonction d'affectation de copie
    Foo& operator=(const Foo&) = delete;
};

Le mot-clé delete prend également en charge la suppression de fonctions non membres

template<typename T>
void Process(T value);

template<>
void Process<void>(void) = delete;

Règle 10.1.3 Utiliser nullptr, pas NULL ou 0

Raison Depuis longtemps, C++ n’a pas de mot-clé pour représenter un pointeur nul, ce qui est une situation embarrassante :

#define NULL ((void *)0)

char* str = NULL;   // Erreur: void* ne peut pas être converti automatiquement en char*

void(C::*pmf)() = &C::Func;
if (pmf == NULL) {} // Erreur: void* ne peut pas être converti automatiquement en pointeur de fonction membre

Si NULL est défini comme 0 ou 0L. Cela peut résoudre les problèmes ci-dessus.

Ou utilisez directement 0 là où un pointeur nul est nécessaire. Mais cela introduit un autre problème, le code n’est pas clair, surtout lors de l’utilisation de auto pour l’inférence automatique :

auto result = Find(id);
if (result == 0) {  // Find() retourne un pointeur ou un entier?
    // faire quelque chose
}

0 est littéralement de type int (0L est de type long), donc NULL et 0 ne sont pas des types pointeurs. Lors de la surcharge de fonctions pointeurs et entiers, le passage de NULL ou 0 appelle la fonction surchargée de type entier :

void F(int);
void F(int*);

F(0);      // Appelle F(int), pas F(int*)
F(NULL);   // Appelle F(int), pas F(int*)