当前位置:天才代写 > tutorial > C语言/C++ 教程 > Google C++编程气势气魄指南(一)

Google C++编程气势气魄指南(一)

2017-11-04 08:00 星期六 所属: C语言/C++ 教程 浏览:1116

副标题#e#

配景

Google的开源项目大多利用C++开拓。每一个C++措施员也都知道,C++具有许多强大的语言特性,但这种强大不行制止的导致它的巨大,这种巨大会使得代码更易于呈现bug、难于阅读和维护。

本指南的目标是通过具体叙述在C++编码时要奈何写、不要奈何写来规避其巨大性。这些法则可在答允代码有效利用C++语言特性的同时使其易于打点。

气势气魄,也被视为可读性,主要指称打点C++代码的习惯。利用术语气势气魄有点用词不妥,因为这些习惯远不止源代码文件名目这么简朴。

使代码易于打点的要领之一是加强代码一致性,让别人可以读懂你的代码是很重要的,保持统一编程气势气魄意味着可以轻松按照“模式匹配”法则揣度各类标记的寄义。建设通用的、必须的习习用语和模式可以使代码越发容易领略,在某些环境下改变一些编程气势气魄大概会是好的选择,但我们照旧应该遵循一致性原则,只管不这样去做。

本指南的另一个概念是C++特性的臃肿。C++是一门包括大量高级特性的巨型语言,某些环境下,我们会限制甚至克制利用某些特性使代码简化,制止大概导致的各类问题,指南中罗列了这类特性,并表明说为什么这些特性是被限制利用的。

由Google开拓的开源项目将遵照本指南约定。

留意:本指南并非C++教程,我们假定读者已经对C++很是熟悉。

头文件

凡是,每一个.cc文件(C++的源文件)都有一个对应的.h文件(头文件),也有一些破例,如单位测试代码和只包括main()的.cc文件。

正确利用头文件可令代码在可读性、文件巨细和机能上大为更改。

下面的法则将引导你规避利用头文件时的各类贫苦。

1.#define的掩护

所有头文件都应该利用#define防备头文件被多重包括(multiple inclusion),定名名目当是:<PROJECT>_<PATH>_<FILE>_H_

为担保独一性,头文件的定名应基于其地址项目源代码树的全路径。譬喻,项目foo中的头文件foo/src/bar/baz.h按如下方法掩护:

#ifndef FOO_BAR_BAZ_H_

#define FOO_BAR_BAZ_H_

…

#endif // FOO_BAR_BAZ_H_


#p#副标题#e#

2.头文件依赖

利用前置声明(forward declarations)只管淘汰.h文件中#include的数量。

当一个头文件被包括的同时也引入了一项新的依赖(dependency),只要该头文件被修改,代码就要从头编译。假如你的头文件包括了其他头文件,这些头文件的任何改变也将导致那些包括了你的头文件的代码从头编译。因此,我们甘心只管少包括头文件,尤其是那些包括在其他头文件中的。

利用前置声明可以显著淘汰需要包括的头文件数量。举例说明:头文件顶用到类File,但不需要会见File的声明,则头文件中只需前置声明class File;无需#include "file/base/file.h"。

在头文件如何做到利用类Foo而无需会见类的界说?

1) 将数据成员范例声明为Foo *或Foo &;

2) 参数、返回值范例为Foo的函数只是声明(但不界说实现);

3) 静态数据成员的范例可以被声明为Foo,因为静态数据成员的界说在类界说之外。

另一方面,假如你的类是Foo的子类,可能含有范例为Foo的非静态数据成员,则必需为之包括头文件。

有时,利用指针成员(pointer members,假如是scoped_ptr更好)替代工具成员(object members)简直更有意义。然而,这样的做法会低落代码可读性及执行效率。假如仅仅为了少包括头文件,照旧不要这样替代的好。

虽然,.cc文件无论如何都需要所利用类的界说部门,自然也就会包括若干头文件。

译者注:能依赖声明的就不要依赖界说。

3.内联函数

只有当函数只有10行甚至更少时才会将其界说为内联函数(inline function)。

界说(Definition):当函数被声明为内联函数之后,编译器大概会将其内联展开,无需按凡是的函数挪用机制挪用内联函数。

利益:当函数体较量小的时候,内联该函数可以令方针代码越发高效。对付存取函数(accessor、mutator)以及其他一些较量短的要害执行函数。

缺点:滥用内联将导致措施变慢,内联有大概是方针代码量或增或减,这取决于被内联的函数的巨细。内联较短小的存取函数凡是会淘汰代码量,但内联一个很大的函数(译者注:假如编译器答允的话)将戏剧性的增加代码量。在现代处理惩罚器上,由于更好的操作指令缓存(instruction cache),小巧的代码往往执行更快。

结论:一个较量恰当的处理惩罚法则是,不要内联高出10行的函数。对付析构函数应慎重看待,析构函数往往比其外貌看起来要长,因为有一些隐式成员和基类析构函数(假如有的话)被挪用!

另一有用的处理惩罚法则:内联那些包括轮回或switch语句的函数是得不偿失的,除非在大大都环境下,这些轮回或switch语句从不执行。

#p#分页标题#e#

重要的是,虚函数和递归函数纵然被声明为内联的也不必然就是内联函数。凡是,递归函数不该该被声明为内联的(译者注:递归挪用仓库的展开并不像轮回那么简朴,好比递归层数在编译时大概是未知的,大大都编译器都不支持内联递归函数)。析构函数内联的主要原因是其界说在类的界说中,为了利便抑或是对其行为给出文档。

4.-inl.h文件

巨大的内联函数的界说,应放在后缀名为-inl.h的头文件中。

在头文件中给出内联函数的界说,可令编译器将其在挪用处内联展开。然而,实现代码应完全放到.cc文件中,我们不但愿.h文件中呈现太多实现代码,除非这样做在可读性和效率上有明明优势。

假如内联函数的界说较量短小、逻辑较量简朴,其实现代码可以放在.h文件中。譬喻,存取函数的实现理所虽然都放在类界说中。出于实现和挪用的利便,较巨大的内联函数也可以放到.h文件中,假如你以为这样会使头文件显得粗笨,还可以将其疏散到单独的-inl.h中。这样即把实现和类界说分分开来,当需要时包括实现地址的-inl.h即可。

-inl.h文件还可用于函数模板的界说,从而使得模板界说可读性加强。

要提醒的一点是,-inl.h和其他头文件一样,也需要#define掩护。

#p#副标题#e#

5.函数参数顺序(Function Parameter Ordering)

界说函数时,参数顺序为:输入参数在前,输出参数在后。

C/C++ 函数参数分为输入参数和输出参数两种,有时输入参数也会输出(译者注:值被修改时)。输入参数一般传值或常数引用(const references),输出参数或输入/输出参数为很是数指针(non-const pointers)。对参数排序时,将所有输入参数置于输出参数之前。不要仅仅因为是新添加的参数,就将其置于最后,而应该依然置于输出参数之前。

这一点并不是必需遵循的法则,输入/输出两用参数(凡是是类/布局体变量)混在个中,会使得法则难以遵循。

6.包括文件的名称及序次

将包括序次尺度化可加强可读性、制止埋没依赖(hidden dependencies,译者注:埋没依赖主要是指包括的文件中编译时),序次如下:C库、C++库、其他库的.h、项目内的.h。

项目内头文件应凭据项目源代码目次树布局分列,而且制止利用UNIX文件路径.(当前目次)和..(父目次)。譬喻,google-awesome-project/src/base/logging.h应像这样被包括:

#include "base/logging.h"

dir/foo.cc的主要浸染是执行或测试dir2/foo2.h的成果,foo.cc中包括头文件的序次如下:

dir2/foo2.h(优先位置,详情如下)

C系统文件

C++系统文件

其他库头文件

本项目内头文件

这种排序方法可有效淘汰埋没依赖,我们但愿每一个头文件独立编译。最简朴的实现方法是将其作为第一个.h文件包括在对应的.cc中。

dir/foo.cc和dir2/foo2.h凡是位于沟通目次下(像base/basictypes_unittest.cc和base/basictypes.h),但也可在差异目次下。

沟通目次下头文件按字母序是不错的选择。

举例来说,google-awesome-project/src/foo/internal/fooserver.cc的包括序次如下:

#include "foo/public/fooserver.h" // 优先位置

#include <sys/types.h>

#include <unistd.h>

#include <hash_map>

#include <vector>

#include "base/basictypes.h"

#include "base/commandlineflags.h"

#include "foo/public/bar.h"

______________________________________

译者:英语不太好,翻译的也就不太好。这一篇主要提到的是头文件的一些法则,总结一下:

1.制止多重包括是学编程时最根基的要求;

2.前置声明是为了低落编译依赖,防备修改一个头文件激发多米诺效应;

3.内联函数的公道利用可提高代码执行效率;

4.-inl.h可提高代码可读性(一般用不到吧:D);

5.尺度化函数参数顺序可以提高可读性和易维护性(对函数参数的仓库空间有轻微影响,我以前大多是沟通范例放在一起);

6.包括文件的名称利用.和..固然利便却易杂乱,利用较量完整的项目路径看上去很清晰、很层次,包括文件的序次除了雅观之外,最重要的是可以淘汰埋没依赖,使每个头文件在“最需要编译”(对应源文件处:D)的处所编译,有人提出库文件放在最后,这样堕落先是项目内的文件,头文件都放在对应源文件的最前面,这一点足以担保内部错误的实时发明白。

 

    关键字:

[contact-form-7 id="17097" title="form2"]天才代写-代写联系方式