Google 开源项目风格指南--C++ 风格指南
6. 命名约定
最重要的一致性规则是命名管理. 命名风格快速获知名字代表是什么东东: 类型? 变量? 函数? 常量? 宏 ... ? 甚至不需要去查找类型声明. 我们大脑中的模式匹配引擎可以非常可靠的处理这些命名规则.
命名规则具有一定随意性, 但相比按个人喜好命名, 一致性更重, 所以不管你怎么想, 规则总归是规则.
6.1. 通用命名规则
Tip
函数命名,变量命名,文件命名要有描述性;少用缩写。
尽可能给有描述性的命名,别心疼空间,毕竟让代码易于新读者理解很重要。不要用只有项目开发者能理解的缩写,也不要通过砍掉几个字母来缩写单词。
int price_count_reader; // 无缩写 int num_errors; // “num” 本来就很常见 int num_dns_connections; // 人人都知道 “DNS” 是啥
Warning
int n; // 莫名其妙。 int nerr; // 怪缩写。 int n_comp_conns; // 怪缩写。 int wgc_connections; // 只有贵团队知道是啥意思。 int pc_reader; // "pc" 有太多可能的解释了。 int cstmr_id; // 有删减若干字母。
6.2. 文件命名
Tip
文件名要全部小写, 可以包含下划线 (_
) 或连字符 (-
). 按项目约定来. 如果并没有项目约定,”_” 更好。
可接受的文件命名:
* my_useful_class.cc * my-useful-class.cc * myusefulclass.cc * muusefulclass_test.cc // ``_unittest`` 和 ``_regtest`` 已弃用。
C++ 文件要以 .cc
结尾, 头文件以 .h
结尾. 专门插入文本的文件则以 .inc
结尾,参见:ref:self-contained headers。
不要使用已经存在于 /usr/include
下的文件名 (Yang.Y 注: 即编译器搜索系统头文件的路径), 如db.h
.
通常应尽量让文件名更加明确. http_server_logs.h
就比 logs.h
要好. 定义类时文件名一般成对出现, 如 foo_bar.h
和 foo_bar.cc
, 对应于类 FooBar
.
内联函数必须放在 .h
文件中. 如果内联函数比较短, 就直接放在 .h
中.
6.3. 类型命名
Tip
类型名称的每个单词首字母均大写, 不包含下划线: MyExcitingClass
, MyExcitingEnum
.
所有类型命名 —— 类, 结构体, 类型定义 (typedef
), 枚举 —— 均使用相同约定. 例如:
// classes and structs class UrlTable { ... class UrlTableTester { ... struct UrlTableProperties { ...// typedefs typedef hash_map<UrlTableProperties *, string> PropertiesMap;// enums enum UrlTableErrors { ...
6.4. 变量命名
Tip
变量名一律小写, 单词之间用下划线连接. 类的成员变量以下划线结尾, 但结构体的就不用,如::a_local_variable
, a_struct_data_member
, a_class_data_member_
.
普通变量命名:
举例:
string table_name; // 可 - 用下划线。 string tablename; // 可 - 全小写。Warning
string tableName; // 差 - 混合大小写。
类数据成员:
不管是静态的还是非静态的,类数据成员都可以和普通变量一样, 但要接下划线。
class TableInfo {...private:string table_name_; // 可 - 尾后加下划线。string tablename_; // 可。static Pool<TableInfo>* pool_; // 可。 };
结构体变量:
不管是静态的还是非静态的,结构体数据成员都可以和普通变量一样, 不用像类那样接下划线:
struct UrlTableProperties {string name;int num_entries; }结构体与类的讨论参考 结构体 vs. 类 一节.
全局变量:
对全局变量没有特别要求, 少用就好, 但如果你要用, 可以用g_
或其它标志作为前缀, 以便更好的区分局部变量.
6.5. 常量命名
Tip
在全局或类里的常量名称前加 k
: kDaysInAWeek. 且除去开头的 k
之外每个单词开头字母均大写。
所有编译时常量, 无论是局部的, 全局的还是类中的, 和其他变量稍微区别一下. k
后接大写字母开头的单词:
const int kDaysInAWeek = 7;
这规则适用于编译时的局部作用域常量,不过要按变量规则来命名也可以。
6.6. 函数命名
Tip
常规函数使用大小写混合, 取值和设值函数则要求与变量名匹配: MyExcitingFunction()
,MyExcitingMethod()
, my_exciting_member_variable()
, set_my_exciting_member_variable()
.
常规函数:
函数名的每个单词首字母大写, 没有下划线。
如果您的某函数出错时就要直接 crash, 那么就在函数名加上 OrDie. 但这函数本身必须集成在产品代码里,且平时也可能会出错。
AddTableEntry() DeleteUrl() OpenFileOrDie()
取值和设值函数:
取值(Accessors)和设值(Mutators)函数要与存取的变量名匹配. 这儿摘录一个类,
num_entries_
是该类的实例变量:class MyClass {public:...int num_entries() const { return num_entries_; }void set_num_entries(int num_entries) { num_entries_ = num_entries; }private:int num_entries_; };其它非常短小的内联函数名也可以用小写字母, 例如. 如果你在循环中调用这样的函数甚至都不用缓存其返回值, 小写命名就可以接受.
6.7. 名字空间命名
Tip
名字空间用小写字母命名, 并基于项目名称和目录结构: google_awesome_project
.
关于名字空间的讨论和如何命名, 参考 名字空间 一节.
6.8. 枚举命名
Tip
枚举的命名应当和 常量 或 宏 一致: kEnumName
或是 ENUM_NAME
.
-
单独的枚举值应该优先采用 常量 的命名方式. 但 宏 方式的命名也可以接受. 枚举名
UrlTableErrors
(以及AlternateUrlTableErrors
) 是类型, 所以要用大小写混合的方式. -
enum UrlTableErrors {kOK = 0,kErrorOutOfMemory,kErrorMalformedInput, }; enum AlternateUrlTableErrors {OK = 0,OUT_OF_MEMORY = 1,MALFORMED_INPUT = 2, };
2009 年 1 月之前, 我们一直建议采用 宏 的方式命名枚举值. 由于枚举值和宏之间的命名冲突, 直接导致了很多问题. 由此, 这里改为优先选择常量风格的命名方式. 新代码应该尽可能优先使用常量风格. 但是老代码没必要切换到常量风格, 除非宏风格确实会产生编译期问题.
6.9. 宏命名
Tip
你并不打算:ref:使用宏 <preprocessor-macros>, 对吧? 如果你一定要用, 像这样命名:MY_MACRO_THAT_SCARES_SMALL_CHILDREN
.
参考:ref:预处理宏 <preprocessor-macros>; 通常 不应该 使用宏. 如果不得不用, 其命名像枚举命名一样全部大写, 使用下划线:
#define ROUND(x) ... #define PI_ROUNDED 3.0
6.10. 命名规则的特例
Tip
如果你命名的实体与已有 C/C++ 实体相似, 可参考现有命名策略.
bigopen()
:
函数名, 参照open()
的形式
uint
:
typedef
bigpos
:
struct
或class
, 参照pos
的形式
sparse_hash_map
:
STL 相似实体; 参照 STL 命名约定
LONGLONG_MAX
:
常量, 如同INT_MAX
译者(acgtyrant)笔记
- 感觉 Google 的命名约定很高明,比如写了简单的类 QueryResult, 接着又可以直接定义一个变量 query_result, 区分度很好;再次,类内变量以下划线结尾,那么就可以直接传入同名的形参,比如 TextQuery::TextQuery(std::string word) : word_(word) {}, 其中
word_
自然是类内私有成员。
文档转自http://zh-google-styleguide.readthedocs.io/en/latest/google-cpp-styleguide/naming/
Google 开源项目风格指南--C++ 风格指南相关推荐
- Google开源项目风格指南-笔记
Google 开源项目风格指南--中文版 Google C++ Style Guide 1. 头文件 1.1 前置声明 类似于函数的声明和定义,C++里类的声明和定义也是可以分开的.我们可以先声明而暂 ...
- tcmalloc(google开源项目核心部分模拟实现)
TcMalloc项目实现--高并发内存池(google开源项目核心部分模拟实现) 一.项目介绍 二.什么是内存池 2.1 池化技术 2.2 内存池 2.3 内存池 三.定长内存池 四.整体框架设计 T ...
- 【转载】35 个你也许不知道的 Google 开源项目
Google是支持开源运动的最大公司之一,它们现在总共发布有超过500个的开源项目(大部分都是利用它们的API来完成),本文将列举一些有趣的开源项目,其中很可能有不少你不知道的哦. 文本文件处理: G ...
- Google开源项目WebRTC下载及编译
操作系统:Windows 10 IDE: Visual Studio 2019 官网:https://chromium.googlesource.com/external/webrtc 一.前言 由于 ...
- TCmalloc (google开源项目核心部分模拟实现)
目录 1什么是内存池 1.1池化技术 1.2内存池 2.开胃菜-设计一个定长内存池 代码实现: ObjectPool.h ObjectPool.cpp测试 3.TCmalloc(高并发内存池)整体框架 ...
- 【读书笔记】摘自Google开源项目风格指南-C++风格指南
1.#define保护 使用#define防止头文件被多重包含 #ifndef <PROJECT>_<PATH>_<FILE>_H_ #define <PRO ...
- Google 开源项目风格指南
Python风格规范 分号 Tip 不要在行尾加分号, 也不要用分号将两条命令放在同一行. 行长度 Tip 每行不超过80个字符 例外: 长的导入模块语句 注释里的URL 不要使用反斜杠连接行. Py ...
- 听说用这个7岁小孩都能编程-Google开源项目blockly
Google Blockly,一个网页应用,通过摆积木一样的拖放各种编程模块,七岁小孩都能轻松创建一小段程序. 打开 Google Blockly网站,有三个演示链接: 1.迷宫编程 2.普通编程工具 ...
- Google 有哪些牛逼的开源项目?
本文盘点 Google 开源项目中 Star 最多的 6 个开源项目.@逛逛GitHub 历史还盘点过百度.阿里.腾讯等互联网大厂的开源成果,可以查看历史文章翻阅. 本期推荐开源项目目录: 1. 核心 ...
最新文章
- java 性能检测工具 检测死锁等
- java lo流_javaIO:字节流
- php代码 2012057
- 新年第一赛,提交BUG奖励多
- 前端学习(2037)vue之电商管理系统电商系统之优化
- php phar效率,PHP的Phar包原来性能这么强
- HDU 4380 Farmer Greedy(叉积和三角形知识的综合应用)
- C# string.Format json格式字符串报错”输入字符串的格式不正确“
- 【JeecgBoot】关于 jeecg-boot 的项目理解、使用心得和改进建议
- SecureCRT下载、安装、激活
- mysql jdbc 连接池配置
- 本地视频做成html网页,使用HTML和JavaScript播放本地的媒体(视频音频)文件的方法...
- Cygwin安装教程并构建WFDB软件包
- 百度搜索引擎都有哪些算法
- html中如何淡化背景图片,excel怎么去除背景图片
- 使用EasyExcel导出图片及异常处理
- 抽样中误差的相关概念和种类
- Android 常用正则表达式,android编程实战
- 大长今》及主题歌五种版本欣赏
- 青云QingCloud与陕中二院联手打造智慧医院范本