遵循Google C++编码规范，提升代码清晰度与可读性

需积分: 3 148 浏览量更新于2024-07-28 收藏 329KB PDF 举报

身份认证购VIP最低享 7 折!

领优惠券(最高得80元）

"Google_C++_Style_Guide 是Google公司制定的一套C++编程规范，旨在提高代码的清晰度和可读性，是编程人员遵循的最佳实践。这份指南包括了从头文件处理、命名规则、类设计到异常处理等多个方面的详细指导。" 以下是基于给定文件信息提取的相关知识点： 1. **头文件管理** - **`#define` Guard**：为了防止头文件被多次包含，推荐在每个头文件中使用预处理器宏来保护，例如`#ifndef`、`#define`和`#endif`。 - **Header File Dependencies**：头文件应该只包含它们真正需要的其他头文件，减少不必要的依赖关系。 2. **内联函数与`.inl.h`文件** - **Inline Functions**：内联函数用于优化，但不应该滥用，因为它们可能导致代码膨胀。 - **`.inl.h` Files**：将内联函数定义放在单独的`.inl.h`文件中，允许用户根据需要决定是否包含它们。 3. **函数参数顺序** - **FunctionParameterOrdering**：通常，应首先声明常量和引用参数，然后是值参数。 4. **命名与包含** - **Names and Order of Includes**：遵循特定的头文件包含顺序，例如，先包含系统头文件，再包含库头文件，最后是项目内的头文件。 - **Namespaces**：使用命名空间来避免命名冲突，推荐使用小写字母和下划线组合的命名方式。 5. **作用域与类** - **Scoping**：尽可能限制变量的作用域，避免全局变量。 - **Nested Classes**：嵌套类用于封装相关数据，谨慎使用。 - **Nonmember, Static Member, and Global Functions**：非成员函数可以提高代码的模块化，静态成员函数属于类但不依赖于类实例，全局函数则独立于任何类。 6. **变量与局部变量** - **Local Variables**：尽量减少局部变量的生命周期，避免使用大对象作为局部变量。 - **Static and Global Variables**：尽量避免静态和全局变量，它们可能导致难以预料的行为。 7. **类设计** - **Doing Work in Constructors**：构造函数只负责初始化，不应执行其他工作。 - **Default Constructors**：默认构造函数应提供，除非类不打算被默认初始化。 - **Explicit Constructors**：对于单参数构造函数，使用`explicit`关键字防止隐式类型转换。 - **Copy Constructors**：复制构造函数用于创建对象的副本，应确保正确处理资源的复制和释放。 - **Structs vs. Classes**：根据数据封装的需要选择使用struct或class，struct默认成员是public，class默认是private。 8. **继承** - **Inheritance**：使用继承来实现"is-a"关系，遵循单一职责原则。 - **Multiple Inheritance**：多重继承可能导致复杂性增加，谨慎使用。 - **Interfaces**：使用抽象基类（接口）定义一组纯虚函数，提供多态性。 9. **运算符重载** - **Operator Overloading**：只重载有意义的运算符，遵循操作符的语义。 10. **访问控制与声明顺序** - **Access Control**：使用private、protected和public控制访问级别。 - **Declaration Order**：声明顺序应反映其逻辑上的相关性，私有成员通常放在最前面。 11. **写短函数** - **Write Short Functions**：函数应该尽可能短小，便于理解和测试。 12. **Google特定的实践** - **Magic Numbers**：避免魔法数字，用常量代替。 - **Smart Pointers**：使用智能指针管理动态分配的对象，减少内存泄漏。 - **cpplint**：Google提供的C++代码风格检查工具，用于自动化风格检查。 13. **其他C++特性** - **Reference Arguments**：使用引用参数传递对象，避免拷贝。 - **Function Overloading**：通过参数列表不同实现多态。 - **Default Arguments**：为函数提供默认参数，增加灵活性。 - **Variable-Length Arrays and alloca()**：避免使用VLA和alloca()，因为它们可能导致栈溢出。 - **Friends**：谨慎使用友元，以保持封装性。 - **Exceptions**：使用异常处理来处理预期之外的错误。 - **Run-Time Type Information (RTTI)**：使用RTTI进行类型检查，但应适度，因为它会影响性能。 - **Casting**：推荐使用`static_cast`、`const_cast`、`dynamic_cast`和`reinterpret_cast`进行类型转换，以提高安全性。遵循这些Google C++ Style Guide的规范，可以使代码更加一致、可读且易于维护，有助于提升团队合作效率和软件质量。

资源详情

资源推荐

Cons:

Nonmember and static member functions may make more sense as

members of a new class, especially if they access external resources or have

significant dependencies.

Decision:

Sometimes it is useful, or even necessary, to define a function not bound to a

class instance. Such a function can be either a static member or a nonmember

function. Nonmember functions should not depend on external variables, and

should nearly always exist in a namespace. Rather than creating classes only to

group static member functions which do not share static data, use namespaces

instead.

Functions defined in the same compilation unit as production classes may

introduce unnecessary coupling and link-time dependencies when directly called

from other compilation units; static member functions are particularly susceptible

to this. Consider extracting a new class, or placing the functions in a namespace

possibly in a separate library.

If you must define a nonmember function and it is only needed in its

.cc

file, use

an unnamed namespace

static

linkage (eg

static int Foo() {...}

) to

limit its scope.

Local Variables

▽

Place a function's variables in the narrowest scope possible, and initialize

variables in the declaration.

LINK

C++ allows you to declare variables anywhere in a function. We encourage you

to declare them in as local a scope as possible, and as close to the first use as

possible. This makes it easier for the reader to find the declaration and see what

type the variable is and what it was initialized to. In particular, initialization

should be used instead of declaration and assignment, e.g.

int i;

i = f(); // Bad -- initialization separate from declaration.

int j = g(); // Good -- declaration has initialization.

Note that gcc implements

for (int i = 0; i < 10; ++i)

correctly (the

scope of

is only the scope of the

for

loop), so you can then reuse

another

for

loop in the same scope. It also correctly scopes declarations in

and

while

statements, e.g.

while (const char* p = strchr(str, '/')) str = p + 1;

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.

11/05/2010 Google C++ Style Guide

…googlecode.com/svn/…/cppguide.xml 9/50

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.

LINK

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.

LINK

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:

11/05/2010 Google C++ Style Guide

…googlecode.com/svn/…/cppguide.xml 10/50

剩余49页未读，继续阅读

yxnyxnyxnyxnyxn

粉丝: 88
资源: 48

遵循Google C++编码规范，提升代码清晰度与可读性

Google_C++_Style_Guide_谷歌_C++编码风格指南.docx

Google_Cpp_Style_guide_CN.zip_C++_guide_style

Google_C++_Style_Guide（中文版+英文版）

google c++ style guide pdf

google c++ style guide网盘

google c++ style guide

google c++ style guide 中文

C++google style

谷歌c++编码规范链接

vs c++ style

google C++命名规范

normalize C++

google代码规范都有哪些

C++做好的程序ijjiool

Cannot read property 'open' of undefined

C语言代码的格式规范文档

python'bool' object has no attribute

Cannot read property 'insert' of undefined

FileNotFoundError: [Errno 2] No such file or directory: 'VOCdevkit/JPEGImages/classes.jpg'

D:\py\python.exe: can t open file C:\\Users\\86153\\PycharmProjects\\pythonProject\\main.py : [Errno 2] No such file or directory

最新资源