Google 开源项目风格指南

原文网址：http://zh-google-styleguide.readthedocs.org/en/latest/google-cpp-styleguide/naming/

其中，蓝色字体为我本身的命名风格，之后看着方便

文件：所有小写，可包含下划线；如：my_useful_class;

类型（类、结构体、类型定义typedef、枚举） ：每一个单词首字母均大写；如：MyExcitingClass；

变量/结构体：小写，可含下划线；如：my_local_varible;

类成员变量：小写，可含下划线，如下划线结尾；如：my_local_varible_;

函数：第一个单词小写，后面每一个单词首字母大写；如：addTableEntry();

常量：k开头，后跟每一个单词首字母大写；如：kDaysInAweek;

全局变量： g_开始， 如g_my_exciting;

6. 命名约定

最重要的一致性规则是命名管理. 命名风格快速获知名字表明是什么东东: 类型? 变量? 函数? 常量? 宏 ... ? 甚至不须要去查找类型声明. 咱们大脑中的模式匹配引擎能够很是可靠的处理这些命名规则.

命名规则具备必定随意性, 但相比按我的喜爱命名, 一致性更重, 因此无论你怎么想, 规则总归是规则.

6.1. 通用命名规则

Tip

函数命名, 变量命名, 文件命名应具有描述性; 不要过分缩写. 类型和变量应该是名词, 函数名能够用 “命令性” 动词.

如何命名:

尽量给出描述性的名称. 不要节约行空间, 让别人很快理解你的代码更重要. 好的命名风格:

int num_errors; // Good. int num_completed_connections; // Good. 

糟糕的命名使用含糊的缩写或随意的字符:

int n; // Bad - meaningless. int nerr; // Bad - ambiguous abbreviation. int n_comp_conns; // Bad - ambiguous abbreviation. 

类型和变量名通常为名词: 如 FileOpener, num_errors.

函数名一般是指令性的 (确切的说它们应该是命令), 如 OpenFile(), set_num_errors(). 取值函数是个特例 (在 函数命名 处详细阐述), 函数名和它要取值的变量同名.

缩写:

除非该缩写在其它地方都很是广泛, 不然不要使用. 例如:

// Good
// These show proper names with no abbreviations. int num_dns_connections; // 大部分人都知道 "DNS" 是啥意思. int price_count_reader; // OK, price count. 有意义. 

Warning

// Bad!
// Abbreviations can be confusing or ambiguous outside a small group. int wgc_connections; // Only your group knows what this stands for. int pc_reader; // Lots of things can be abbreviated "pc". 

永远不要用省略字母的缩写:

int error_count; // Good. int error_cnt; // Bad. 

6.2. 文件命名

Tip

文件名要所有小写, 能够包含下划线 (_) 或连字符 (-). 按项目约定来.

可接受的文件命名:

my_useful_class.cc
my-useful-class.cc
myusefulclass.cc

C++ 文件要以 .cc 结尾, 头文件以 .h 结尾.

不要使用已经存在于 /usr/include 下的文件名 (yospaly 注: 即编译器搜索系统头文件的路径), 如 db.h.

一般应尽可能让文件名更加明确. http_server_logs.h 就比 logs.h 要好. 定义类时文件名通常成对出现, 如 foo_bar.h 和 foo_bar.cc, 对应于类 FooBar.

内联函数必须放在 .h 文件中. 若是内联函数比较短, 就直接放在 .h 中. 若是代码比较长, 能够放到以 -inl.h 结尾的文件中. 对于包含大量内联代码的类, 可使用三个文件:

url_table.h      // The class declaration.
url_table.cc     // The class definition.
url_table-inl.h  // Inline functions that include lots of code.

参考 -inl.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

变量名一概小写, 单词之间用下划线链接. 类的成员变量如下划线结尾, 如:

my_exciting_local_variable
my_exciting_member_variable_ 

普通变量命名:

举例:

string table_name;  // OK - uses underscore.
string tablename;   // OK - all lowercase.

Warning

string tableName; // Bad - mixed case. 

结构体变量:

结构体的数据成员能够和普通变量同样, 不用像类那样接下划线:

struct UrlTableProperties { string name; int num_entries; } 

结构体与类的讨论参考 结构体 vs. 类 一节.

全局变量:

对全局变量没有特别要求, 少用就好, 但若是你要用, 能够 用 g_ 或其它标志 做为前缀, 以便更好的区分局部变量.

6.5. 常量命名

Tip

在名称前加 k: kDaysInAWeek.

全部编译时常量, 不管是局部的, 全局的仍是类中的, 和其余变量稍微区别一下. k 后接大写字母开头的单词::

const int kDaysInAWeek = 7;

6.6. 函数命名

Tip

常规函数使用大小写混合, 取值和设值函数则要求与变量名匹配: MyExcitingFunction(), MyExcitingMethod(), my_exciting_member_variable(), set_my_exciting_member_variable().

常规函数:

函数名的每一个单词首字母大写, 没有下划线:（我选择第一个单词首字母小写，以区分类）

AddTableEntry() DeleteUrl() 

取值和设值函数:

取值和设值函数要与存取的变量名匹配. 这儿摘录一个类, 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

你并不打算 使用宏, 对吧? 若是你必定要用, 像这样命名: MY_MACRO_THAT_SCARES_SMALL_CHILDREN.

参考 预处理宏 <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