Google的C++命名规范

向右看齐 2022-04-17 07:13 390阅读 0赞

头文件：

1. 避免多重包含是学编程时最基本的要求；

2. 前置声明是为了降低编译依赖，防止修改一个头文件引发多米诺效应；

3. 内联函数的合理使用可提高代码执行效率；

4. -inl.h 可提高代码可诺性（一般用丌到吧:D），内联代码放到这个里面；

5. 标准化函数参数顺序可以提高可读性和易维护性（对函数参数的堆栈空间有轻微影响，我以前大多是相同类型放在一起）；

6. 包含文件的名称使用.和..虽然方便却易混乱，使用比教完整的项目路径看上去很清晰、很条理，包含文件的次序除了美观乊外，最重要的是可以减少隐藏依赖，使每个头文件在“最需要编译”（对应源文件处:D）的地方编译，有人提出库文件放在最后，这样出错先是项目内的文件，头文件都放在对应源文件的最前面，返一点足以保证内部错误的及时发现了。

作用域：

1. .cc 中的不具名命名空间可避免命名冲突、限定作用域，避免直接使用 using 提示符污染命名空间；

2. 嵌套类符合局部使用原则，只是不能在其他头文件中前置声明，尽量不要 public；

3. 尽量不用全局函数和全局发量，考虑作用域和命名空间限制，尽量单独形成编译单元；

4. 多线程中的全局发量（含静态成员变量）不要使用 class 类型（含 STL 容器），避免不明确行为导致的bugs。

作用域的使用，除了考虑名称污染、可读性之外，主要是为降低耦合度，提高编译、执行效率。

C++类：

1. 不在构造函数中做太多逻辑相关的初始化；

2. 编译器提供的默认构造函数不会对变量进行初始化，如果定义了其他构造函数，编译器不再提供，需要编码者自行提供默认构造函数；

3. 为避免隐式转换，需将单参数构造函数声明为 explicit；

4. 为避免拷贝构造函数、赋值操作的滥用和编译器自动生成，可目前声明其为 private 且无需实现；

5. 仅在作为数据集合时使用 struct；

6. 组合>实现继承>接口继承>私有继承，子类重载的虚函数也要声明 virtual 关键字，虽然编译器允许不这样做；

7. 避免使用多重继承，使用时，除一个基类含有实现外，其他基类均为纯接口；

8. 接口类类名以 Interface 为后缀，除提供带实现的虚枂极函数、静态成员函数外，其他均为纯虚函数，不定义非静态数据成员，不提供构造函数，提供的话，声明为 protected；

9. 为降低复杂性，尽量不重载操作符，模板、标准类中使用时提供文档说明；

10. 存取函数一般内联在头文件中；例如get和set

11. 声明次序：public->protected->private；

12. 函数体尽量短小、紧凑，功能单一

智能指针和其他C++特性：

1. 对于智能指针，安全第一、方便第二，尽可能局部化（scoped\_ptr）；

2. 引用形参加上 const，否则使用指针形参；

3. 函数重轲的使用要清晰、易读；

4. 鉴于容易误用，禁止使用缺省函数参数（值得商榷）；

5. 禁止使用变长数组；

6. 合理使用友元；

7. 为了方便代码管理，禁止使用异常（值得商榷）；

8. 禁止使用 RTTI，否则重新设计代码吧；

9. 使用 C++风格的类型转换，除单元测试外不要使用 dynamic\_cast；

10. 使用流还是 printf + read/write，it is a problem；

11. 能用前置自增/减不用后置自增/减；

12. const 能用则用，提倡 const 在前；

13. 使用确定大小的整型，除位组外不要使用无符号型；

14. 格式化输出及结构对齐时，注意 32 位和 64 位的系统差异；

15. 除字符串化、还接外尽量避免使用宏；

16. 整数用 0，实数用 0.0，指针用 NULL，字符（串）用'\\0'；

17. 用 sizeof(varname)代替 sizeof(type)；

18. 只使用 Boost 中被认可的库

命名约定：

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

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

3. 变量（含类、结构体成员发量）、文件、命名空间、存取函数等使用全部小写+下划线，类成员变量以下划线（\_）结尾，全局变量以 g\_开头，常量(不管是全局还是局部)都以小k开头；

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

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

代码注释：

1. 关于注释风格，很多 C++的 coders 更喜欢行注释，C coders 或许对块注释依然情有独钟，或者在文件头大段大段的注释时使用块注释；

2. 文件注释可以炫耀你的成就，也是为了捅了篓子别人可以找你；

3. 注释要言简意赅，不要拖沓冗余，复杂的东西简单化和简单的东西复杂化都是要被鄙规的；

4. 对予 Chinese coders 来说，用英文注释还是用中文注释，it is a problem，但不管怎样，注释是为了让别人看懂，难道是为了炫耀编程语言之外的你的母语或外语水平吗；

5. 注释不要太乱，适当的缩进才会让人乐意看，但也没有必要归定注释从第几列开始（我自己写代码的时候总喜欢这样），UNIX/LINUX 下还可以约定是使用 tab 迓是 space，个人倾向于 space；

6. TODO很不错，有时候，注释确实是为了标记一些未完成的或完成的不尽如人意的地方，这样一搜索，就知道还有哪些活要干，日志都省了。

格式：

1. 行宽原则上不超过 80 列，把 22 寸的显示屏都占完，怎么也说不过去；

2. 尽量不使用非 ASCII 字符，如果使用的话，参考 UTF-8 格式（尤其是 UNIX/Linux 下，Windows 下可以考虑宽字符），尽量不将字符串常量耦合到代码中，比如独立出资源文件，这不仅仅是风格问题了；

3. UNIX/Linux 下无条件使用空格，MSVC 的话使用 Tab 也无可厚非；

4. 函数参数、逻辑条件、初始化列表：要么所有参数和函数名放在同一行，要么所有参数并排分行；

5. 除函数定义的左大括号可以置于行首外，包括函数/类/结极体/枚举声明、各种语句的左大括号置于行尾，所有右大括号独立成行；

6. . / ->操作符前后不留空格，\* / &不要前后都留，一个就可，靠左靠右依各人喜好；

7. 预处理指令/命名空间不使用额外缩进，类/结构体/枚举/函数/语句使用缩进；

8. 初始化用=还是()依个人喜好，统一就好；

9. return 不要加()；

10. 水平/垂直留白不要滥用，怎么易读怎么来。

发表评论取消回复

表情：

评论列表（有 0 条评论，390人围观）

还没有评论，来说两句吧...

相关阅读

相关 C－简明命名规范

分享一个大牛的人工智能教程。零基础！通俗易懂！风趣幽默！希望你也加入到人工智能的队伍中来！请点击[http://www.captainbed.net][http_www.cap

我就是我/ 2022年12月27日 01:59/ 0 赞/ 217 阅读

相关 Google的Objective-C编码规范

[http://www.cnblogs.com/junwang/archive/2011/03/04/1970569.html][http_www.cnblogs.com_ju

痛定思痛。/ 2022年08月24日 00:50/ 0 赞/ 180 阅读

相关 C,C++中命名规范

C++以及MFC的命名规则基本上是符合匈牙利命名法的，匈牙利命名法是一种编程时的命名规范。基本原则是：变量名＝属性＋类型＋对象描述，其中每一对象的名称都要求有明确含义，可以

╰半夏微凉°/ 2022年07月15日 08:40/ 0 赞/ 325 阅读

相关 Google C++编程规范

出处：http://blog.csdn.net/voidccc/article/details/37599203 一张图总结Google C++编程规范(Goog

「爱情、让人受尽委屈。」/ 2022年06月05日 11:28/ 0 赞/ 218 阅读

相关 C#命名规范

Pascal 规则（帕斯卡命名）每个单词开头的字母大写(如 TestCounter). Camel 规则(大驼峰和小驼峰命名) 除了第一个单词外的其他单词的开

素颜马尾好姑娘i/ 2022年05月31日 14:17/ 0 赞/ 279 阅读

相关 C/C++命名规范-C语言基础

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ub

绝地灬酷狼/ 2022年04月23日 08:10/ 0 赞/ 744 阅读

相关 Google的C++命名规范

头文件： 1. 避免多重包含是学编程时最基本的要求； 2. 前置声明是为了降低编译依赖，防止修改一个头文件引发多米诺效应； 3. 内联函数的合理使用可提高代码执行效率；

向右看齐/ 2022年04月17日 07:13/ 0 赞/ 391 阅读

相关命名规范

一、项目名全部小写，比如cms、workdesk,jobserver等二、java相关命名 a、类命名：每音节单词前的第一个字母大写，比如FieldInfo、Exp

ゝ一纸荒年。/ 2022年04月10日 02:55/ 0 赞/ 433 阅读

相关命名规范

不能用什么命名？ 1：不能中文命名 2：不能中英混合 3: 不能直接使用css属性明敏 4：不能单独切直接使用html命名命名规则- 驼峰式命名:

￡神魔★判官ぃ/ 2021年11月02日 07:06/ 0 赞/ 502 阅读

相关 C#控件命名规范

Data Control <table style="font-family:Verdana;"> <tbody> <tr> <td>类型</td>

你的名字/ 2021年10月18日 15:50/ 0 赞/ 342 阅读