[CPP] Coding Style

本Coding Style用来约束C++编程，使得代码在有效使用C++语言特性的同时易于管理【代码的一致性高于一切】。

参考：《Google C++ Style Guide》

每个.cc文件都应对应一个.h文件

1 #ifndef SDK_SRC_ABC_H_
2 #define SDK_SRC_ABC_H_
3 ...
4 #endif // SDK_SRC_ABC_H_

2. 使用函数时，采用#include方式；

3. 使用类模版时，采用#include方式；

4. 使用普通类时，采用前置声明；

5. 数据成员为类自身的指针或引用时，采用前置声明；

2. 析构函数应慎重对待；

3. 内联包含循环或switch语言的函数将得不偿失；

4. 虚函数和递归函数即使被声明为内联也不一定是内联函数；

2. 输出参数为非常数指针、非常数引用；

2. 项目内.h文件应按照项目源代码目录树结构排列，并且避免使用UNIX文件.（当前目录）和..（父目录）；

3. 相同目录下.h文件按字母序排列；

#include “base/logging.h”;

2. 某foo.cc文件中包含.h文件次序：

1 #include “foo/public/foo.h”
2 #include <sys/types.h>
3 #include <hash_map>
4 #include <foo/public/bar.h>

2. 具名命名空间的名称基于项目或路径名称；

3. 不要使用using指示符；

4. 在.cc文件、.h文件中的函数和类中，可以使用using；

5. 在.cc文件、.h文件中的函数和类中，可以使用命名空间别名；

6. 不要使用inline namespace；

1 namespace
2 {
3 enum {UNUSED, EOF, ERROR}; // 无缩进
4 bool foo() {return EOF;}
5 } // namespace

2. 具名命名空间：

1 namespace mynamespace
2 {
3 class MyClass
4 {
5 public:
6     void foo();
7 };
8 } // namespace mynamespace

2. 嵌套类作为接口的一部分时，置于命名空间中；

1 class Foo
2 {
3 private:
4     class Bar
5     {
6     };
7 };

2. 若确定需要定义非成员函数，并且只在.cc文件中使用它，可使用不具名命名空间或static关联限定其作用域；

2. 多线程代码中禁止非常数全局变量，不可使用函数返回值初始化全局变量；

3. 全局字符串常量，使用C风格字符串，而不要使用STL字符串；

4. 大多数全局变量应该是类的静态数据成员，或当其只在.cc文件中使用时，将其定义到不具名命名空间中，或者使用静态关联以限制变量的作用域；

5. 静态成员变量视作全局变量，不能是class类型；

1 const char kFrogSays[] = “ribbet”;

2. 如果对象需要有意义的初始化，可以采用工厂函数或者Init()方法集中初始化；

3. 构造函数禁止调用虚函数；

 1 #define DISALLOW_COPY_AND_ASSIGN(Type)  2     Type(const Type&);                  3     void operator = (const Type&)
 4
 5 class Foo
 6 {
 7 public:
 8     Foo(int f);
 9     ~Foo();
10 private:
11     DISALLOW_COPY_AND_ASSIGN(Foo);
12 };

2. 对于functor和trait，可以使用struct；

3. 类和结构体的成员变量使用不同的命名规则；

2. 不要过多使用实现继承，更多使用组合；

3. 使析构函数为virtual，如果该类具有虚函数，其析构函数一定为虚函数；

4. 限定仅在子类访问的成员函数为protected，数据成员应始终为私有；

5. 重定义派生的虚函数时，在派生类中明确声明其为virtual；

2. 纯接口必须以Interface为后缀；

2. 接口类必须声明虚析构函数，析构函数不能纯虚函数；

* 只有纯虚函数和静态函数（析构函数除外）；

* 没有非静态数据成员；

* 没有定义任何构造函数，若有，须不含参数，且为protected；

* 如果是子类，只能继承满足以上条件并以Interface为后缀的类；

2. STL容器中作为key要重载operator==或operator<，可以在声明容器的时候，创建相等判断和大小比较的仿函数类型；

2. 存取函数的定义一般内联在头文件中；

2. 每一块中，声明次序为：typedef和enum、常量（static const数据成员）、构造函数、析构函数、成员函数（含静态成员函数）、数据成员（除static const数据成员）；

3. 宏DISALLOW_COPY_AND_ASSIGN置于private:块之后，作为类的最后部分；

4. .cc文件中函数的定义顺序和声明次序一致；

2. 输入参数采用const引用，输出参数采用指针；

3. 输入参数可以是const指针，但不可以是non-const引用；

2. 除单元测试外不要使用dynamic_cast；

2. sizeof(void *) != sizeof(int)，可以用intptr_t定义指针大小的整数；

3. 结构体字节对齐；

4. 创建64位常量时使用LL或ULL作为后缀；

2. 在.h文件中，除了#define防止头文件重包含外，不要定义宏；

Compressed Pair：boost/compressed_pair.hpp；

Pointer Container：boost/ptr_container，其中不包括ptr_array.hpp和serialization；

最重要是一致性

2. 除非放到项目外也非常明了，否则不要使用缩写；

2.  int num_dns_connections;

3.  int error_count; // Good.

int error_cnt;   // Bad.

2. 源文件以.cc结尾，头文件以.h结尾；

my_useful_class.cc

my-useful-class.cc

myusefulclass.cc

2. 如：MyExcitingClass、UrlTable；

2. 结构体数据成员可以和普通变量一样，不用像类的成员数据那样以下划线结尾；

3. 全局变量以g_作为前缀；

1 my_exciting_local_variable
2 my_exciting_member_variable_

2.

1 struct UrlTablePoperties
2 {
3     sting name;
4     int num_entries;
5 };

2. 其它短小的内联函数可以使用小写字母；

1 MyExcitingMethod()
2 set_my_exciting_member_variable()

2. 如果类的实例可被多线程访问，使用时务必文档说明；

2. 构造/析构函数前无需注释；

* inputs及outputs；

* 类成员函数：函数调用期间对象是否需要保持引用参数，是否会释放这些参数；

* 如果函数分配了空间，需要由调用者释放；

* 参数是否可以为NULL；

* 是否存在函数使用的性能隐忧；

* 如果函数是可重入的，其同步前提是什么；

2. 函数定义处定义的内容：

注释说明函数功能和实现要点；

2. 相邻几行都有注释的，可以调整使//纵向对齐；

2. 如果函数为const的，const应与最后一个参数位于同一行；

3. 独立行的参数保持4个空格的缩进；

1 ReturnType ClassName::FunctionName(Type ar_name1, Type par_name2)
2 {
3     DoSomething();
4 }

1 if (condition)
2 {
3     ...
4 }
5 else
6 {
7     ...
8 }

1. 在声明指针、引用变量或参数时，（*、&）与类型名紧挨；

2. ‘:’前后各空一格；