遵循谷歌与Cocos2d-x：C++编码规范详解与实践

需积分: 15 20 浏览量更新于2024-07-18 收藏 997KB PDF 举报

谷歌C++编码规范是Google制定的一套针对C++编程的最佳实践标准，旨在提高代码的可读性、文件管理和性能。这套规范源于Google's C++ coding style revision 3.2，并参考了cocos2d-x编码规范。以下是其中的关键要点： 1. **头文件管理**: - 每个`.cpp`文件通常对应一个相关的`.h`文件，但单元测试代码和只有一个`main`函数的文件是例外。 - 避免多重包含的陷阱，通过在`#ifndef`和`#define`之间设置独特的符号名，格式为`<PROJECT>_<PATH>_<FILE>_H_`，确保每个头文件只被一次包含。 2. **预处理器指令**: - 推荐使用`#pragma once`，这是一个跨平台且被现代编译器广泛支持的预处理器指令，用于替代传统的`#ifndef`/`#define`/`#endif`结构，简化包含管理。 3. **前向声明**: - 前向声明允许在不包含完整定义的情况下引用类、函数或模板，减少`#include`带来的副作用。 - 优点是可以减少编译次数，降低编译时间，但缺点是可能导致难以理解和确定模板细节、隐式转换问题，以及API兼容性限制。 - 在决定是否使用前向声明时，需要权衡代码清晰度与编译性能的关系。 4. **使用原则**: - 对于头文件中声明的函数，始终确保包含相应的头文件。 - 类模板优先使用`#include`，以获得完整的接口和类型信息。 - 尽量避免因前向声明导致的代码结构复杂，除非确实能带来显著性能提升，这方面的效果并未得到证实。遵循谷歌C++编码规范有助于创建健壮、高效和易于维护的C++代码，提升团队协作效率，同时保持与Google和其他项目之间的代码风格一致性。开发者在实际开发过程中，应结合具体项目需求和工程实践，灵活运用这些规则。

对只有一个参数的构造函数使用C++关键字explicit 。

定义：定义：一般来说，如果一个构造函数只有一个参数，它可以当做转换函数使用。例如，如果你定义了Foo::Foo(string name) ，然后传进一

个string 类型给一个函数是需要Foo类型的，Foo 的构造函数将会被调用并转换这个string 类型为Foo 类型，然后把这个Foo 类型传递给这个函数。这

能提供便利，但是这也是产生麻烦的根源：当一个对象被转换了，但是它却不是你想要的类型。显式地声明一个构造函数可以防止这种隐性转换。

优点：优点：避免出现不合需求的转换

缺点：缺点：没有

结论：结论：所有的单个参数的构造函数都应该使用explicit显式声明。在定义类的时候，对于只有一个参数的构造函数时总是要在其前面使

用explicit：explicit Foo(string name);

有一点例外的是拷贝构造函数，在一些比较少的情况我们允许它不使用explicit 。还有一种例外的情况是，那些打算作为透明封装的类。这两种情况

都应该明确的进行注释。

最后，构造函数中只有一个初始化列表的可以是非explicit 。这是为了允许你的类型结构可以使用大括号初始列表的方式进行赋值。

拷贝构造函数拷贝构造函数

当需要时应该提供一个拷贝构造函数和赋值操作符。否则，使用DISALLOW_COPY_AND_ASSIGN 来禁用它们

定义：定义：拷贝构造函数和赋值操作符是用来创建一个对象的拷贝。拷贝构造函数是有编译器在某些情况下隐式调用的，例如，以传值方式传一个对象的

时候。

优点：优点：拷贝构造函数使得拷贝对象变得简单。STL容器要求所有的内容都是可以拷贝和赋值的。拷贝构造函数比CopyFrom()方式这种替代方案更高

效，在某些情况，编译器可以省去它们，它也避免了堆分配的开销。

缺点：缺点：在C++中，隐式的拷贝对象可能会引起bugs和性能问题的。它也会减少可读性，因为它使得以传值方式的对象难以跟踪，相对于传引用来说，

对象的改变会立刻得到反馈。

结论：结论：很少类需要能被拷贝。大部分类时不需要拷贝构造函数和赋值操作符的。在许多情况下，一个指针或者引用和一个被拷贝的值使用起来是差不

多的，然而它们却更高效。例如，你可以以引用或者指针的方式传递函数参数来代替传值方式，你也可以用指针替代类对象来保存在STL容器里面。

如果你的类需要能被拷贝，与其提供一个拷贝构造函数，不如提供提供一个例如clone() 的拷贝函数更好，因为这样的函数不能被隐式的调用。如果一

个拷贝方法不满足你的需求情况（例如，考虑到性能原因，或者你的类需要以值方式保存在STL容器里面），可以也再提供拷贝构造函数和赋值操作

符。

如果你的类不需要拷贝构造函数或者赋值操作符，你必须显式禁用它们。你可以这样子做，在类里面以私有方式为拷贝构造函数和赋值操作符添加声

明，记得不要对它们提供任何对应的实现（这样会导致链接错误）。

为了方便，可以这样定义一个DISALLOW_COPY_AND_ASSIGN 宏：

// A macro to disallow the copy constructor and operator= functions

// This should be used in the private: declarations for a class

#define DISALLOW_COPY_AND_ASSIGN(TypeName) \

TypeName(const TypeName&); \

void operator=(const TypeName&)

然后，在类Foo 里面的实现就可以这样：

class Foo

{

public:

Foo(int f);

~Foo();

private:

DISALLOW_COPY_AND_ASSIGN(Foo);

};

委派和继承构造函数委派和继承构造函数

可以减少重复代码时使用委派和继承构造函数。

定义：定义：

委派构造函数和继承构造函数是为了减少构造函数重复代码而在C++11中引入的两个不同的特性。委派构造函数允许类的一个构造函数通过特殊的初

始化列表语法调用另外的构造函数。

X::X(const string& name) : name_(name)

{

...

}

X::X() : X("") { }

继承构造函数允许派生类可以直接使用基类的构造函数，就像使用基类的其他成员函数，而不需要重新声明这些构造函数。尤其当基类有多个构造函

数时特别有用。

class Base

{

public:

Base();

Base(int n);

Base(const string& s);

...

};

class Derived : public Base

{

public:

using Base::Base; // Base's constructors are redeclared here.

};

当派生类构造函数仅仅只是调用基类构造函数时特别有用。

优点：优点：

委派构造函数和继承构造函数可以减少冗余代码，从而提高代码可读性。

Java程序员对委派构造函数很熟悉。

缺点：缺点：

使用辅助函数可以预估委派构造函数的行为。

如果派生类引入了新的成员变量，那么继承构造函数会被迷惑，因为基类构造函数不知道这些新的成员变量。

结论：结论：

当可以减少冗余、提高可读性的时候使用委派构造函数和继承构造函数。当派生类有新的成员变量的时候谨慎对待继承构造函数。如果派生类成员变

量使用类内成员初始化(in-class member initialization)，继承构造函数仍然是适用的。

结构体结构体 vs 类类

仅当只有数据时使用struct ，其它一概使用class 。

在C++中，关键字struct 和class 几乎含义等同，我们为其人为添加语义，以便为定义的数据类型合理选择使用哪个关键字。

struct被用在仅包含数据的消极对象（passive objects）上，可能包括有关联的常量，但没有存取数据成员之外的函数功能，而存取功能通过直接访问

实现而无需方法调用，这里提到的方法是指只用于处理数据成员的，如构造函数、析构函数、Initialize()、Reset()、Validate()。

如果需要更多的函数功能，class 更适合，如果不确定的话，直接使用class 。

为了与STL保持一直，仿函数（functors）和特性（traits）可以不用class而是使用struct 。

注意：类和结构体的成员变量使用不同的命名规则。

继承继承

剩余41页未读，继续阅读

大白兔奶糖Oo

粉丝: 1
资源: 1

遵循谷歌与Cocos2d-x：C++编码规范详解与实践

C++_Coding_Standards_101_Rule

C++编程规范-101条规则(C++ Coding Standards)中文版 part1

谷歌 c++编码规范

google c++ 编码规范

google C++编码规范

Google C++ 编码规范

谷歌C++编码规范 Google C++ 风格指南

Google C++ Style Guide(谷歌C++编码规范 )

谷歌C++编码规范中文版

Google C++编码规范中文版

最新资源