### Google C++ 编程风格指南
#### 背景
Google 的许多项目采用 C++ 进行开发。虽然 C++ 提供了丰富的语言特性，但这也带来了复杂性，这可能导致代码更容易出现错误、难以阅读和维护。因此，制定一套编码规范显得尤为重要。这份文档的目标是通过详细阐述 C++ 编码的最佳实践来规避语言本身的复杂性，确保代码在有效利用 C++ 语言特性的同时易于管理。提高代码的一致性可以帮助他人更好地理解代码，同时也降低了理解和调试代码的难度。
#### 头文件
- **#define 保护**：为了避免头文件被多次包含而导致的问题，所有头文件都应使用 `#define` 保护。命名规则通常是 `<PROJECT>_<PATH>_<FILE>_H_`，其中 `<PROJECT>` 是项目名称，`<PATH>` 和 `<FILE>` 分别是文件所在的路径和文件名。例如，在项目 `foo` 中的 `foo/src/bar/baz.h` 应使用以下形式进行保护：
```cpp
#ifndef FOO_SRC_BAR_BAZ_H_
#define FOO_SRC_BAR_BAZ_H_
// 头文件内容
#endif // FOO_SRC_BAR_BAZ_H_
```
- **头文件依赖**：通过使用前置声明来减少 `.h` 文件中的 `#include` 数量，以降低因头文件变更引起的不必要的编译。例如，如果一个类使用了 `File` 类型但并不需要访问其完整定义，可以在头文件中简单声明 `class File;`，而不是 `#include "file/base/file.h"`。在头文件中，可以通过以下几种方式使用类 `Foo` 而不必包含其完整定义：
- 将数据成员声明为 `Foo*` 或 `Foo&`。
- 函数参数或返回值类型为 `Foo` 时，仅声明函数而不提供具体实现。
- 静态数据成员的类型可以声明为 `Foo`，因为静态数据成员的定义位于类定义之外。
- **内联函数**：只有当函数非常短小（不超过 10 行）时才考虑将其定义为内联函数。内联函数的主要优势在于提高代码执行效率，特别是在函数体较小的情况下。但是，过度使用内联函数可能导致目标代码体积增大，从而影响程序性能。因此，建议仅在函数体非常简洁的情况下使用内联。
#### 作用域
- **局部变量**：局部变量应当尽可能地在其作用域内声明和使用，以提高代码的可读性和维护性。
- **类成员变量**：对于类成员变量，应当考虑它们的作用域和可见性。使用私有成员变量来封装内部状态，并通过公有接口提供必要的访问。
#### C++ 类
- **构造函数与析构函数**：构造函数用于初始化对象的状态，而析构函数负责清理资源。应当谨慎使用构造函数初始化列表，并确保析构函数能够正确释放资源。
- **继承**：在设计类层次结构时，合理使用继承可以提高代码的复用性。但是，过度继承可能导致设计过于复杂。应当优先考虑组合而非继承。
- **虚函数**：虚函数提供了多态的基础，应当谨慎使用以确保正确的运行时行为。
#### 智能指针与其他 C++ 特性
- **智能指针**：使用智能指针（如 `std::unique_ptr` 和 `std::shared_ptr`）可以自动管理内存资源，避免内存泄漏和悬挂指针等问题。
- **其他特性**：限制使用某些复杂的 C++ 特性（如模板元编程），以保持代码的简洁性和可维护性。
#### 命名约定
- **变量和函数**：使用有意义且描述性强的名称，遵循一致的命名规则（如驼峰式命名或下划线分隔）。
- **类和接口**：类名应清晰反映其功能和职责，接口应以 `I` 开头。
#### 代码注释
- **注释风格**：编写清晰、简洁的注释，解释代码的目的和逻辑。
- **文档注释**：对于重要的函数、类和模块，提供详细的文档注释以帮助其他开发者理解其用途和用法。
#### 格式
- **缩进与空格**：使用一致的缩进和空格约定，例如每层缩进使用两个空格。
- **括号和花括号**：遵循一致的括号和花括号使用规则，例如始终在行尾放置花括号。
- **换行**：每行代码不应过长，通常建议每行不超过 80 个字符。
#### 规则之例外
- 在特定情况下，某些规则可能不适用或需要调整。在这种情况下，应当记录这些例外情况，并明确指出为何偏离标准规则。
Google 的 C++ 编程风格指南旨在通过制定一系列详细的规定来提升代码质量和可维护性。这些规定涵盖了从头文件管理、作用域到类设计等多个方面，有助于开发者编写出高质量的 C++ 代码。
