Google C++ Style Guide

• 语言: 英语
• 格式: .pdf
• 来源: github.com/fgaray

摘要

《Google C++ Style Guide》旨在通过详细的规则和约定来管理C++语言的复杂性，确保代码的一致性和可读性。该指南强调了编写清晰、易维护代码的重要性，涵盖了命名约定、文件结构、指针和引用的使用、异常处理、流式输出以及代码布局等核心内容。文档特别指出，代码可读性应优先于编写速度，并建议避免使用可能导致代码难以维护的复杂构造。此外，指南还讨论了如何处理现有不符合规范的代码以及特定平台（如Windows）的特殊情况。

AI总结

《Google C++ Style Guide》是一份旨在规范Google及其开源项目中C++代码风格的指南，其核心目标是通过明确的规则和原则，提升代码的可读性、可维护性和一致性，同时降低复杂性。以下是文档的核心内容总结：

### 1. **背景与目标**
- **语言特点**：C++功能强大但复杂，可能导致代码难以维护和调试。
- **目标**：通过详细规范C++代码的编写方式，平衡语言功能的使用与复杂性管理，确保代码基的可管理性和可读性。
- **风格定义**：风格（style）不仅指代码格式，还包括代码结构、命名约定等，涵盖代码质量的多个方面。

### 2. **风格指南的核心原则**
- **规则的价值**：规则的收益必须显著，且适用于所有工程师。
- **以读者为中心**：代码需要长期维护，优先考虑阅读和维护的体验。
- **一致性**：保持代码风格的一致性，便于工具处理和团队协作。
- **避免复杂性**：避免使用危险或复杂的语言特性，特别是当它们可能影响代码的可维护性时。

### 3. **具体规则**
- **命名约定**：
- 避免匈牙利命名法（如`iNum`）。
- 使用Google命名规范，例如使用`.cc`和`.h`文件扩展名。
- **类型转换**：
- 使用C++风格的`static_cast`、`const_cast`、`reinterpret_cast`和`dynamic_cast`，避免C风格的类型转换。
- 使用`brace initialization`进行类型转换。
- **输入输出**：
- 使用C++流（如`std::cout`和`std::cin`）代替`printf`，因其更安全、可移植且易于扩展。
- **异常处理**：
- 避免在Google代码中使用异常，尤其是现有代码，因为Google代码通常不支持异常处理。
- **RTTI（运行时类型信息）**：
- 避免使用`typeid`和`dynamic_cast`，因为它们可能导致设计问题和维护困难。
- **C++11特性**：
- 一般允许使用C++11特性，但禁止某些特定功能，如``和`ref-qualifiers`。
- **非标准扩展**：
- 避免使用非标准扩展（如`__attribute__`和`__builtin_prefetch`），除非绝对必要。
- **头文件使用**：
- 每个`.cc`文件应有一个对应的`.h`文件，以提高代码的模块化和可维护性。

### 4. **例外与特殊情况**
- **现有代码**：在处理不符合指南的代码时，应保持本地一致性。
- **Windows编程**：允许使用Windows特定的类型（如`DWORD`）和API，但需尽量接近C++标准类型。
- **性能优化**：在必要时可突破规则，但需谨慎评估其对可读性和维护性的影响。

### 5. **总体原则**
- **一致性**：保持代码风格的统一，便于团队协作和工具处理。
- **可维护性**：避免过度复杂的语言特性，特别是当代码需要长期维护时。
- **公共命名空间**：避免污染全局命名空间，以减少命名冲突的风险。
- **工具兼容性**：确保代码与Google工具和流程兼容，如格式化工具和编译器设置。

### 6. **总结**
《Google C++ Style Guide》通过明确的规则和原则，帮助开发者编写高质量、可维护、一致且易于理解的C++代码。这些规则不仅适用于Google内部项目，也为开源社区提供了宝贵的参考。