C++代码规范表
命名规范 |
函数命名, 变量命名, 文件命名要有描述性; 少用缩写 |
|
文件名要全部小写, 可以包含下划线_或连字符-,依照项目的约定. 如果没有约定, 那么_更好 |
|
类型名称的每个单词首字母均大写, 不包含下划线 |
|
变量 (包括函数参数) 和数据成员名一律小写, 单词之间用下划线连接。类的成员变量以下划线结尾, 但结构体的就不用 |
|
声明为 constexpr 或 const 的变量, 或在程序运行期间其值始终保持不变的, 命名时以“k”开头, 大小写混合 |
|
常规函数使用大小写混合, 取值和设值函数则要求与变量名匹配 |
|
命名空间以小写字母命名 |
|
宏定义 全大写加下划线 |
格式规范 |
只使用空格, 每次缩进 2 个空格 |
|
返回类型和函数名在同一行, 参数也尽量放在同一行, 如果放不下就对形参分行, 分行方式与函数调用一致 |
|
每一行代码字符数不超过 80 |
|
句点或箭头前后不要有空格. 指针/地址操作符 (*, &) 之后不能有空格 |
|
预处理指令不要缩进, 从行首开始 |
注释规范 |
使用 // 或 /* */ |
|
每个类的定义都要附带一份注释, 描述类的功能和用法, 除非它的功能相当明显 |
|
函数声明处的注释描述函数功能; 定义处的注释描述函数实现 |
|
通常变量名本身足以很好说明变量用途 |