没有合适的资源?快使用搜索试试~ 我知道了~
首页Google开源项目中文风格指南:统一编码规范
"Google开源项目风格指南(中文版)是一份详细的编程规范手册,主要针对Google内部使用的编程风格,旨在提供一致性和可读性,使得理解和协作大型代码库更加顺畅。这份指南不仅适用于C++、Objective-C、Python和JSON等语言,还包含了对Google内部编码标准的深度解析。 该文档由国内开发者根据Google的官方英文版风格指南进行本地化制作,并以reStructuredText格式编排,支持多种文档格式如HTML、CHM和PDF。中文版风格指南更便于国内开发者的理解和实践,有助于提高代码质量与团队协作效率。 值得注意的是,尽管这个中文项目并非官方发布,但它提供了Google C++风格指南、Objective-C风格指南、Python风格指南和JSON风格指南,覆盖了关键的编程语言领域。此外,文档还推荐了CPPLint工具,这是一款用于检查代码是否符合风格准则的实用工具,以及google-c-style.el,一个用于Emacs编辑器的Google编码风格配置文件。 为了进一步丰富资源,项目方正在寻找志愿者翻译JavaScript和XML文档格式的风格指南,有兴趣的开发者可以通过联系Yang.Y.参与进来。版权信息和文档修订历史也被清晰标注,体现了文档的完整性和社区维护的态度。 Google开源项目风格指南(中文版)是提升代码质量和项目一致性的重要参考资料,对于遵循Google编码规范的开发者来说,无论是学习还是实践,都具有很高的价值。"
资源详情
资源推荐
1. 头文件 — Google 开源项目风格指南
http://zh-google-styleguide.readthedocs.org/en/latest/google-cpp-styleguide/headers/[2016/1/8 14:40:02]
Edit on GitHub
Docs » C++
风格指南
-
内容目录
» 1.
头文件
1.
头文件
通常每一个 .cc 文件都有一个对应的 .h 文件. 也有一些常见例外, 如单元测试代码和只包含 main()
函数的 .cc 文件.
正确使用头文件可令代码在可读性、文件大小和性能上大为改观
.
下面的规则将引导你规避使用头文件时的各种陷阱
.
1.1. Self-contained
头文件
Tip
头文件应该能够自给自足(self-contained),以 .h 结尾。至于用来插入文本的文件,说到底它
们并不是头文件,所以应以
.inc 结尾。
所有头文件要能够自给自足。换言之,用户和重构工具不需要为特别场合而包含额外的头文件。详言
之,一个头文件要有
1.2. #define
保护,统统包含它所需要的其它头文件,也不要求定义任何特别
symbols.
不过有一个例外,即一个文件并不是
self-contained
的,而是用来安插到代码某处里,特别是要安插
多次的时候。或者,文件内容实际上是其它头文件的特定平台(
platform-specific
)扩展部分。这些文
件就要用
.inc 文件扩展名。
如果
.h 文件声明了一个模板或内联函数,同时也在该文件加以定义。凡是有用到这些的 .cc 文件,
就得统统包含该头文件,否则程序可能会在构建中链接失败。现在不要把这些定义放到分离的
-inl.h
文
件里了(译者注:过去该规范曾提倡把定义放到
-inl.h
里过)。
有个例外:如果某函数模板为所有相关模板参数显式实例化,或本身就是某类的一个私有成员,那么
它就只能定义在实例化该模板的
.cc 文件里。
Google
开源项目风格指南
1. 头文件 — Google 开源项目风格指南
http://zh-google-styleguide.readthedocs.org/en/latest/google-cpp-styleguide/headers/[2016/1/8 14:40:02]
1.2. #define
保护
Tip
所有头文件都应该使用 #define 防止头文件被多重包含, 命名格式当是: <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_
1.3.
前置声明
Tip
您可以靠前置声明来避免多余的 #includes .
定义:
所谓「前置声明」(
forward declaration
)是类,函数和模板的纯粹声明,没伴随着其定义。代码
中用到了哪些 symbols, 往往可以用其前置声明来代替对应的
#includes .
优点:
多余的 #includes 会害得编译器花费不少时间展开更多文件,处理大量输入。
而且一旦改动头文件,就得重新编译整个文件。
缺点:
如果前置声明关系到模板,typedefs, 默认参数和 using 声明,就很难决定它的具体样子了。
很难判断什么时候该用前置声明,什么时候该用 #includes , 特别是涉及隐式转换运算符的时
候。极端情况下,用前置声明代替
includes 甚至都会暗暗地改变代码的含义。
前置声明了不少来自头文件的 symbol 时,就会比单单 includes 一行冗长。
前置声明函数或模板有时会害得头文件开发者难以轻易变动其 API. 就像扩大形参类型,加个自
带默认参数的模板形参等等。
前置声明来自命名空间 ``std::` 的 symbol 时,其行为未定义。
仅仅为了能前置声明而重构代码(比如用指针成员代替对象成员),后者会变慢且复杂起来。
1. 头文件 — Google 开源项目风格指南
http://zh-google-styleguide.readthedocs.org/en/latest/google-cpp-styleguide/headers/[2016/1/8 14:40:02]
还没有实践证实前置声明的优越性。
结论:
函数:用 #include .
类模板:优先用 #includes .
类:用前置声明固然不错,但小心点。若说不定,还是用 #includes 好了。
千万别为了避免 includes 而把数据成员改成指针。
至于什么时候包含头文件,参见
name-and-order-of-includes
。
1.4.
内联函数
Tip
只有当函数只有
10
行甚至更少时才将其定义为内联函数
.
定义
:
当函数被声明为内联函数之后
,
编译器会将其内联展开
,
而不是按通常的函数调用机制进行调用
.
优点
:
当函数体比较小的时候
,
内联该函数可以令目标代码更加高效
.
对于存取函数以及其它函数体比较
短
,
性能关键的函数
,
鼓励使用内联
.
缺点
:
滥用内联将导致程序变慢
.
内联可能使目标代码量或增或减
,
这取决于内联函数的大小
.
内联非常短
小的存取函数通常会减少代码大小
,
但内联一个相当大的函数将戏剧性的增加代码大小
.
现代处理器
由于更好的利用了指令缓存
,
小巧的代码往往执行更快。
结论
:
一个较为合理的经验准则是
,
不要内联超过
10
行的函数
.
谨慎对待析构函数
,
析构函数往往比其表
面看起来要更长
,
因为有隐含的成员和基类析构函数被调用
!
另一个实用的经验准则: 内联那些包含循环或 switch 语句的函数常常是得不偿失 (除非在大多数情
况下, 这些循环或
switch 语句从不被执行).
有些函数即使声明为内联的也不一定会被编译器内联
,
这点很重要
;
比如虚函数和递归函数就不会被
正常内联
.
通常
,
递归函数不应该声明成内联函数
.
(
YuleFox
注
:
递归调用堆栈的展开并不像循环那
1. 头文件 — Google 开源项目风格指南
http://zh-google-styleguide.readthedocs.org/en/latest/google-cpp-styleguide/headers/[2016/1/8 14:40:02]
么简单
,
比如递归层数在编译时可能是未知的
,
大多数编译器都不支持内联递归函数
).
虚函数内联的
主要原因则是想把它的函数体放在类定义内
,
为了图个方便
,
抑或是当作文档描述其行为
,
比如精短
的存取函数
.
1.5.
函数参数的顺序
Tip
定义函数时
,
参数顺序依次为
:
输入参数
,
然后是输出参数
.
C/C++ 函数参数分为输入参数, 输出参数, 和输入/输出参数三种. 输入参数一般传值或传 const 引用,
输出参数或输入/输出参数则是非-
const 指针. 对参数排序时, 将只输入的参数放在所有输出参数之前.
尤其是不要仅仅因为是新加的参数
,
就把它放在最后
;
即使是新加的只输入参数也要放在输出参数之前
.
这条规则并不需要严格遵守
.
输入
/
输出两用参数
(
通常是类
/
结构体变量
)
把事情变得复杂
,
为保持和相
关函数的一致性
,
你有时不得不有所变通
.
1.6. #include 的路径及顺序
Tip
使用标准的头文件包含顺序可增强可读性
,
避免隐藏依赖
:
相关头文件
, C
库
, C++
库
,
其他库的
.h,
本项目内的
.h.
项目内头文件应按照项目源代码目录树结构排列, 避免使用 UNIX 特殊的快捷目录 . (当前目录) 或
.. (上级目录). 例如, google-awesome-project/src/base/logging.h 应该按如下方式包含:
#include “base/logging.h”
又如, dir/foo.cc 的主要作用是实现或测试 dir2/foo2.h 的功能, foo.cc 中包含头文件的次序如下:
1.
dir2/foo2.h (优先位置, 详情如下)
2. C 系统文件
3. C++ 系统文件
4. 其他库的
.h 文件
5. 本项目内
.h 文件
这种排序方式可有效减少隐藏依赖
.
我们希望每一个头文件都是可被独立编译的
(Yang.Y
译注
:
即该头
文件本身已包含所有必要的显式依赖), 最简单的方法是将其作为第一个
.h 文件 #included 进对应的
.cc .
1. 头文件 — Google 开源项目风格指南
http://zh-google-styleguide.readthedocs.org/en/latest/google-cpp-styleguide/headers/[2016/1/8 14:40:02]
dir/foo.cc
和
dir2/foo2.h
通常位于同一目录下 (如
base/basictypes_unittest.cc
和
base/basictypes.h
),
但也可以放在不同目录下
.
按字母顺序对头文件包含进行二次排序是不错的主意
(Yang.Y
译注
:
之前已经按头文件类别排过序了
).
您所依赖的
symbols
被哪些头文件所定义,您就应该包含(
include
)哪些头文件,
forward-
declaration 情况除外。比如您要用到 bar.h 中的某个 symbol, 哪怕您所包含的 foo.h 已经包含了
bar.h , 也照样得包含 bar.h , 除非 foo.h 有明确说明它会自动向您提供 bar.h 中的 symbol. 不过,
凡是
cc
文件所对应的「相关头文件」已经包含的,就不用再重复包含进其
cc
文件里面了,就像
foo.cc 只包含 foo.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"
例外:
有时,平台特定(
system-specific
)代码需要条件编译(
conditional includes
),这些代码可以放到其
它
includes
之后。当然,您的平台特定代码也要够简练且独立,比如:
#include "foo/public/fooserver.h"
#include "base/port.h" // For LANG_CXX11.
#ifdef LANG_CXX11
#include <initializer_list>
#endif // LANG_CXX11
译者
(YuleFox)
笔记
1. 避免多重包含是学编程时最基本的要求;
2. 前置声明是为了降低编译依赖,防止修改一个头文件引发多米诺效应;
3. 内联函数的合理使用可提高代码执行效率;
4. -inl.h 可提高代码可读性 (一般用不到吧:D);
5. 标准化函数参数顺序可以提高可读性和易维护性 (对函数参数的堆栈空间有轻微影响, 我以前大多是
相同类型放在一起
);
剩余172页未读,继续阅读
天风立马
- 粉丝: 0
- 资源: 5
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
最新资源
- 构建Cadence PSpice仿真模型库教程
- VMware 10.0安装指南:步骤详解与网络、文件共享解决方案
- 中国互联网20周年必读:影响行业的100本经典书籍
- SQL Server 2000 Analysis Services的经典MDX查询示例
- VC6.0 MFC操作Excel教程:亲测Win7下的应用与保存技巧
- 使用Python NetworkX处理网络图
- 科技驱动:计算机控制技术的革新与应用
- MF-1型机器人硬件与robobasic编程详解
- ADC性能指标解析:超越位数、SNR和谐波
- 通用示波器改造为逻辑分析仪:0-1字符显示与电路设计
- C++实现TCP控制台客户端
- SOA架构下ESB在卷烟厂的信息整合与决策支持
- 三维人脸识别:技术进展与应用解析
- 单张人脸图像的眼镜边框自动去除方法
- C语言绘制图形:余弦曲线与正弦函数示例
- Matlab 文件操作入门:fopen、fclose、fprintf、fscanf 等函数使用详解
资源上传下载、课程学习等过程中有任何疑问或建议,欢迎提出宝贵意见哦~我们会及时处理!
点击此处反馈
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功