Google C++编码规范详解：提升代码质量的必读指南
需积分: 16 29 浏览量
更新于2024-07-26
收藏 1.58MB PDF 举报
Google C++编码规范（完整版）是Google为提升其开源项目中C++代码质量而制定的一份详细指南。这份规范旨在帮助C++程序员解决语言的强大特性和复杂性带来的问题，通过提供明确的编码准则，减少bug、提高代码可读性和维护性。C++作为Google的主要开发语言，它的特性既强大又富有挑战，包括模板、继承、多态等，这些特性在带来灵活性的同时也增加了代码的复杂度。
该规范详细罗列了一系列重要的编程原则，每个原则都有简短的总结，用户可以通过点击旁边的小三角箭头来查看更丰富的背景信息和解释。比如，可能会有对特定设计模式的推荐，如何避免内存泄漏，如何编写清晰的命名规则，以及如何处理异常和错误处理等内容。此外，规范还强调了注释的重要性，提倡编写易于理解的文档，并鼓励使用简洁、一致的代码风格。
遵循Google C++编码规范可以帮助开发者写出更健壮、高效且易于协作的代码，尤其是在团队环境中，统一的编码标准能够提升整体代码质量。它不仅适用于新手，对于有经验的开发者来说，也能作为一个持续改进和学习的参考框架。
值得注意的是，这份规范并不是一成不变的，随着语言的发展和最佳实践的演变，Google可能会在未来更新和调整这些指导原则。因此，开发者在使用时应保持关注最新版本，确保自己的编码风格与业界的最佳实践保持同步。
在阅读和遵循Google C++编码规范时，建议采取以下步骤：
1. 先浏览概览部分，了解整个规范的大致结构。
2. 对于每个重要的编程原则，先阅读总结，然后根据三角箭头查看扩展内容。
3. 针对个人编程习惯和项目需求，选择或调整适合的规则。
4. 在实际编程过程中，不断应用并反思规范，通过实践提升编码技能。
5. 定期回顾和更新对规范的理解，适应语言和工具的变化。
通过遵循这份规范，开发者可以提升C++编程水平，同时为Google和其他开源社区贡献高质量的代码。
There is one caveat: if the variable is an object, its constructor is invoked every time it enters scope and is created,
and its destructor is invoked every time it goes out of scope.
// Inefficient implementation:
for (int i = 0; i < 1000000; ++i) {
Foo f; // My ctor and dtor get called 1000000 times each.
f.DoSomething(i);
}
It may be more efficient to declare such a variable used in a loop outside that loop:
Foo f; // My ctor and dtor get called once each.
for (int i = 0; i < 1000000; ++i) {
f.DoSomething(i);
}
Static and Global Variables
Static or global variables of class type are forbidden: they cause hard-to-find bugs due to indeterminate order of
construction and destruction.
Objects with static storage duration, including global variables, static variables, static class member variables, and
function static variables, must be Plain Old Data (POD): only ints, chars, floats, or pointers, or arrays/structs of POD.
The order in which class constructors and initializers for static variables are called is only partially specified in C++
and can even change from build to build, which can cause bugs that are difficult to find. Therefore in addition to
banning globals of class type, we do not allow static POD variables to be initialized with the result of a function,
unless that function (such as getenv(), or getpid()) does not itself depend on any other globals.
Likewise, the order in which destructors are called is defined to be the reverse of the order in which the constructors
were called. Since constructor order is indeterminate, so is destructor order. For example, at program-end time a
static variable might have been destroyed, but code still running -- perhaps in another thread -- tries to access it and
fails. Or the destructor for a static 'string' variable might be run prior to the destructor for another variable that
contains a reference to that string.
As a result we only allow static variables to contain POD data. This rule completely disallows vector (use C arrays
instead), or string (use const char []).
If you need a static or global variable of a class type, consider initializing a pointer (which will never be freed), from
either your main() function or from pthread_once(). Note that this must be a raw pointer, not a "smart" pointer, since
the smart pointer's destructor will have the order-of-destructor issue that we are trying to avoid.
Classes
Classes are the fundamental unit of code in C++. Naturally, we use them extensively. This section lists the main dos
and don'ts you should follow when writing a class.
Doing Work in Constructors
In general, constructors should merely set member variables to their initial values. Any complex initialization
should go in an explicit Init() method.
Definition:
It is possible to perform initialization in the body of the constructor.
Pros:
Convenience in typing. No need to worry about whether the class has been initialized or not.
Cons:
The problems with doing work in constructors are:
l
There is no easy way for constructors to signal errors, short of using exceptions (which are forbidden).
l
If the work fails, we now have an object whose initialization code failed, so it may be an indeterminate state.
l
If the work calls virtual functions, these calls will not get dispatched to the subclass implementations. Future
modification to your class can quietly introduce this problem even if your class is not currently subclassed,
causing much confusion.
l
If someone creates a global variable of this type (which is against the rules, but still), the constructor code will
be called before main(), possibly breaking some implicit assumptions in the constructor code. For instance,
gflags will not yet have been initialized.
Decision:
If your object requires non-trivial initialization, consider having an explicit Init() method. In particular, constructors
should not call virtual functions, attempt to raise errors, access potentially uninitialized global variables, etc.
Default Constructors
You must define a default constructor if your class defines member variables and has no other constructors.
Otherwise the compiler will do it for you, badly.
link
▽
link
▽
link
▽
剩余33页未读，继续阅读
2020-05-16 上传
2014-08-12 上传
2011-12-21 上传
2012-07-05 上传
2012-10-15 上传
2021-10-03 上传
2013-04-06 上传
2021-11-12 上传
2012-04-14 上传
lostfinale
- 粉丝: 0
- 资源: 5
我的内容管理
展开
最新资源
- 基于Python和Opencv的车牌识别系统实现
- 我的代码小部件库：统计、MySQL操作与树结构功能
- React初学者入门指南：快速构建并部署你的第一个应用
- Oddish:夜潜CSGO皮肤，智能爬虫技术解析
- 利用REST HaProxy实现haproxy.cfg配置的HTTP接口化
- LeetCode用例构造实践：CMake和GoogleTest的应用
- 快速搭建vulhub靶场：简化docker-compose与vulhub-master下载
- 天秤座术语表：glossariolibras项目安装与使用指南
- 从Vercel到Firebase的全栈Amazon克隆项目指南
- ANU PK大楼Studio 1的3D声效和Ambisonic技术体验
- C#实现的鼠标事件功能演示
- 掌握DP-10：LeetCode超级掉蛋与爆破气球
- C与SDL开发的游戏如何编译至WebAssembly平台
- CastorDOC开源应用程序：文档管理功能与Alfresco集成
- LeetCode用例构造与计算机科学基础：数据结构与设计模式
- 通过travis-nightly-builder实现自动化API与Rake任务构建
