Google C++代码规范笔记（一）

C++规范原文：http://google.github.io/styleguide/cppguide.html
参考翻译：https://zh-google-styleguide.readthedocs.io/en/latest/google-cpp-styleguide/

C++版本的限定

目前本规范对标C++11，因此不应使用C++14和C++17的特性。
编码时应该避免使用最新C++版本（目前为C++17）已移除的特性，以及会导致代码在最新C++版本中出现不同含义的特性。
一些C++特性在本规范中会被限制使用或被禁止使用。
不要使用非标准C++特性（在non-standard extensions一章说明）。

头文件（Header Files）

如果 .h 文件声明了一个模板或内联函数，同时也在该文件加以定义。
至于用来插入文本的文件，说到底它们并不是头文件，所以应以 .inc 结尾。（不允许分离出 -inl.h 头文件的做法）

如果一个文件并不是 self-contained 的，而是作为文本插入到代码某处。或者，文件内容实际上是其它头文件的特定平台（platform-specific）扩展部分。这些文件就要用 .inc 文件扩展名。

模板和内联函数的定义和声明应该放在同一个.h文件里。如果声明和定义分开在不同文件，在.cc使用的时候要全部include进来。
有个例外：如果某函数模板为所有相关模板参数显式实例化，或本身就是某类的一个私有成员，那么允许将其定义在（且只能定义在）实例化该模板的 .cc 文件里。

头文件保护：名字格式:

<PROJECT>_<PATH>_<FILE>_H_

为保证唯一性，应该使用全路径，例如foo/src/bar/baz.h：

#ifndef FOO_BAR_BAZ_H_
#define FOO_BAR_BAZ_H_
...
#endif  // FOO_BAR_BAZ_H_

前置声明：
尽可能地避免使用前置声明（类、函数或模板）。使用 #include 包含需要的头文件即可。

前置声明的好处：可以节省编译时间（要读.h文件）以及不必要的重新编译（.h文件有修改就要重新编译.cc，即使修改和这个.cc不相关）。

内联函数：
只有当函数只有很少代码（例如10 行甚至更少）时才将其定义为内联函数（例如存取函数，或性能关键的函数）。
析构不要内联，析构函数往往比其表面看起来要更长, 因为有隐含的成员和基类析构函数被调用！（现代处理器由于更好的利用了指令缓存, 小巧的代码往往执行更快。）
包含循环或 switch 语句的函数不要内联（除非在大多数情况下, 这些循环或 switch 语句不会被执行）。
有些函数即使声明为内联的也不一定会被编译器内联, 这点很重要; 比如虚函数和递归函数就不会被正常内联。通常, 递归函数不应该声明成内联函数。虚函数内联的主要原因则是想把它的函数体放在类定义内, 或为了图方便, 抑或是当作文档描述其行为, 比如精短的存取函数。

包含头文件：
include头文件的顺序：本文件相关头文件, C库, C++库, 其他库的.h, 本项目内的.h。
例如对于dir/foo.cc，它要包含自己的头文件dir2/foo2.h，则顺序为:

1. dir2/foo2.h.
2. 隔一个空行
3. C system files.
4. C++ system files.
5. 隔一个空行
6. Other libraries’ .h files.
7. Your project’s .h files.

而每一部分的多个头文件按照字母表顺序排列，（对于旧的代码不按字母表顺序的，也要抽时间改正）。
如果有条件编译的，例如下例，隔一个空行放于其后，

#ifdef LANG_CXX11
#include <initializer_list>
#endif  // LANG_CXX11

项目内的头文件应按照项目源代码目录树结构排列，例如对于 my-project/src/base/logging.h ，包含它应该写成：

#include "base/logging.h"

您所依赖的符号 (symbols) 被哪些头文件所定义，您就应该包含（include）哪些头文件。比如您要用到 bar.h 中的某个符号, 哪怕您所包含的 foo.h 已经包含了 bar.h, 也照样得包含 bar.h, 除非 foo.h 有明确说明它会自动向您提供 bar.h 中的 symbol