代码规范(C++)

1.命名规范

1.目录/文件

字母、数字、下划线构成，不同单词用下划线隔开。

2.函数/接口

小驼峰命名法。

3.命名空间

字母、数字、下划线构成，不同单词用下划线隔开，但是尽量只使用一个单词。

4.结构体/类

大驼峰命名法，不包含下划线。

5.变量

小驼峰命名法。

1.局部变量

2.全局变量

需要增加前缀 g_ 。

3.静态变量

需要增加前缀 s_ ，若其同时也是全局变量，则同全局变量的命名方式。

4.类成员变量

需要增加前缀 m_ 。

5.类静态变量

需要增加前缀 s_ 。

6.常量

全大写字母，不同单词用下划线隔开。

5.宏定义

全大写字母，不同单词用下划线隔开。

6.枚举

大驼峰命名法，命名时带上 class 类型，枚举值全小写字母。

原因：避免和宏定义发生冲突

2.注释规范

尽量使用 /* */进行注释，避免使用 //。

1.结构体/类注释

2.接口注释

3.变量注释

3.设计规范

1.声明/定义的位置

宏/枚举/变量/接口的声明和定义的位置遵循就近原则，尽量避免跨文件。

2.结构体或类

当定义的类型只是数据的集合且内部无复杂的处理逻辑时选择用 struct，反之如果更注重行为的封装则选择class 。

原因：struct存在于栈上，用完即销毁。
注意：由于栈有容量限制，避免在struct中存放超大量的值类型。

3.单文件(.hpp) or 多文件(.h,.cpp)

当模块只是一些信息的集合且无复杂内部逻辑可以使用.hpp，反之使用多文件方式。

原因：模块逻辑复杂时，会经常变动，如果引用的外部模块多而使用.hpp时，编译时间会变长。

4.单例类

把构造函数声明为私有。

原因：基于单例的定义，不允许类型不受控制的实例化。