Google C++编程风格指南（五）：命名约定

1.总体规则：不要随意缩写；2.宏、枚举等使用全部大写+下划线；3.变量（含类、结构体成员变量）、文件、命名空间、存取函数等使用全部小写+下划线，类成员变量以下划线结尾，全局变量以g_开头；4.参考现有或相近命名约定……

命名约定

最重要的一致性规则是命名管理，命名风格直接可以直接确定命名实体是：类型、变量、函数、常量、宏等等，无需查找实体声明，我们大脑中的模式匹配引擎依赖于这些命名规则。

命名规则具有一定随意性，但相比按个人喜好命名，一致性更重要，所以不管你怎么想，规则总归是规则。

1.通用命名规则（GeneralNamingRules）

函数命名、变量命名、文件命名应具有描述性，不要过度缩写，类型和变量应该是名词，函数名可以用“命令性”动词。

如何命名
：

尽可能给出描述性名称，不要节约空间，让别人很快理解你的代码更重要，好的命名选择：

intnum_errors;//Good.

intnum_completed_connections;//Good.

丑陋的命名使用模糊的缩写或随意的字符：

intn;//Bad-meaningless.

intnerr;//Bad-ambiguousabbreviation.

intn_comp_conns;//Bad-ambiguousabbreviation.

类型和变量名一般为名词：如

FileOpener

、

num_errors

。

函数名通常是指令性的，如

OpenFile()

、

set_num_errors()

，访问函数需要描述的更细致，要与其访问的变量相吻合。

缩写
：

除非放到项目外也非常明了，否则不要使用缩写，例如：

//Good

//Theseshowpropernameswithnoabbreviations.

intnum_dns_connections;//Mostpeopleknowwhat"DNS"standsfor.

intprice_count_reader;//OK,pricecount.Makessense.

//Bad!

//Abbreviationscanbeconfusingorambiguousoutsideasmallgroup.

intwgc_connections;//Onlyyourgroupknowswhatthisstandsfor.

intpc_reader;//Lotsofthingscanbeabbreviated"pc".

不要用省略字母的缩写：

interror_count;//Good.

interror_cnt;//Bad.

2.文件命名（FileNames）

文件名要全部小写，可以包含下划线（_）或短线（-），按项目约定来。

可接受的文件命名：

my_useful_class.cc

my-useful-class.cc

myusefulclass.cc

C++文件以

.cc

结尾，头文件以

.h

结尾。

不要使用已经存在于

/usr/include

下的文件名（译者注，对UNIX、Linux等系统而言），如

db.h

。

通常，尽量让文件名更加明确，

http_server_logs.h

就比

logs.h

要好，定义类时文件名一般成对出现，如

foo_bar.h

和

foo_bar.cc

，对应类

FooBar

。

内联函数必须放在

.h

文件中，如果内联函数比较短，就直接放在

.h

中。如果代码比较长，可以放到以

-inl.h

结尾的文件中。对于包含大量内联代码的类，可以有三个文件：

url_table.h//Theclassdeclaration.

url_table.cc//Theclassdefinition.

url_table-inl.h//Inlinefunctionsthatincludelotsofcode.

参考第一篇-inl.h文件

一节。

3.类型命名（TypeNames）

类型命名每个单词以大写字母开头，不包含下划线：

MyExcitingClass

、

MyExcitingEnum

。

所有类型命名——类、结构体、类型定义（typedef）、枚举——使用相同约定，例如：

//classesandstructs

classUrlTable{...

classUrlTableTester{...

structUrlTableProperties{...

//typedefs

typedefhash_map<UrlTableProperties*,string>PropertiesMap;

//enums

enumUrlTableErrors{...

4.变量命名（VariableNames）

变量名一律小写，单词间以下划线相连，类的成员变量以下划线结尾，如

my_exciting_local_variable

、

my_exciting_member_variable_

。

普通变量命名
：

举例：

stringtable_name;//OK-usesunderscore.

stringtablename;//OK-alllowercase.

stringtableName;//Bad-mixedcase.

类数据成员
：

结构体的数据成员可以和普通变量一样，不用像类那样接下划线：

structUrlTableProperties{

stringname;

intnum_entries;

}

结构体与类的讨论参考第三篇结构体vs.类

一节。

全局变量
：

对全局变量没有特别要求，少用就好，可以以

g_

或其他易与局部变量区分的标志为前缀。

5.常量命名（ConstantNames）

在名称前加

k

：

kDaysInAWeek

。

所有编译时常量（无论是局部的、全局的还是类中的）和其他变量保持些许区别，

k

后接大写字母开头的单词：

constintkDaysInAWeek=7;

6.函数命名（FunctionNames）

普通函数（regularfunctions，译者注，这里与访问函数等特殊函数相对）大小写混合，存取函数（accessorsandmutators）则要求与变量名匹配：

MyExcitingFunction()

、

MyExcitingMethod()

、

my_exciting_member_variable()

、

set_my_exciting_member_variable()

。

普通函数
：

函数名以大写字母开头，每个单词首字母大写，没有下划线：

AddTableEntry()

DeleteUrl()

存取函数
：

存取函数要与存取的变量名匹配，这儿摘录一个拥有实例变量

num_entries_

的类：

classMyClass{

public:

...

intnum_entries()const{returnnum_entries_;}

voidset_num_entries(intnum_entries){num_entries_=num_entries;}

private:

intnum_entries_;

};

其他短小的内联函数名也可以使用小写字母，例如，在循环中调用这样的函数甚至都不需要缓存其值，小写命名就可以接受。

译者注：从这一点上可以看出，小写的函数名意味着可以直接内联使用。

7.命名空间（NamespaceNames）

命名空间的名称是全小写的，其命名基于项目名称和目录结构：

google_awesome_project

。

关于命名空间的讨论和如何命名，参考第二篇命名空间

。

8.枚举命名（EnumeratorNames）

枚举值应全部大写，单词间以下划线相连：

MY_EXCITING_ENUM_VALUE

。

枚举名称属于类型，因此大小写混合：

UrlTableErrors

。

enumUrlTableErrors{

OK=0,

ERROR_OUT_OF_MEMORY,

ERROR_MALFORMED_INPUT,

};

9.宏命名（MacroNames）

你并不打算使用宏，对吧？如果使用，像这样：

MY_MACRO_THAT_SCARES_SMALL_CHILDREN

。

参考第四篇预处理宏

，通常是不使用宏的，如果绝对要用，其命名像枚举命名一样全部大写、使用下划线：

#defineROUND(x)...

#definePI_ROUNDED3.0

MY_EXCITING_ENUM_VALUE

10.命名规则例外（ExceptionstoNamingRules）

当命名与现有C/C++实体相似的对象时，可参考现有命名约定：

bigopen()

函数名，参考

open()

uint

typedef类型定义

bigpos

struct

或

class，参考

pos

sparse_hash_map

STL相似实体；参考STL命名约定

LONGLONG_MAX

常量，类似

INT_MAX

______________________________________

译者：命名约定就相对轻松许多，在遵从代码一致性、可读性的前提下，略显随意：

1.总体规则：不要随意缩写，如果说ChangeLocalValue写作ChgLocVal还有情可原的话，把ModifyPlayerName写作MdfPlyNm就太过分了，除函数名可适当为动词外，其他命名尽量使用清晰易懂的名词；

2.
宏、枚举等使用全部大写+下划线；

3.变量（含类、结构体成员变量）、文件、命名空间、存取函数等使用全部小写+下划线，类成员变量以下划线结尾，全局变量以g_开头；

4.普通函数、类型（含类与结构体、枚举类型）、常量等使用大小写混合，不含下划线；

5.参考现有或相近命名约定。