C/C++编码规范

Posted 2022-11-28 yll1

一、头文件；
1、所有头文件都应该使用#define防止头文件被多重包含。为保证命名唯一性，头文件命名应基于所在项目源代码树的全路径。格式是：<PROJECT>_<PATH>_<FILE>_H_
2、使用前置声明尽量减少.h文件中#include的数量；
3、只有当函数只有10行一下时才会将其定义为内联函数；
4、定义函数时，参数的顺序为：输入参数在前，输出参数在后；
5、将包含次序标准话可增强可读性、避免隐藏依赖，次序如下：C库，其他库的.h、项目内的.h；

二、命名约定；
1、函数命名、变量命名、文件命名应具有描述性，不要随意缩写；
2、文件名要全部小写，可以包含下划线和短线；
2、宏和枚举使用全部大写+下划线；
3、变量、文件、存取函数使用全部小写+下划线，类成员变量以下划线结尾，全局变量以g_开头；
4、普通函数、类型、常量等使用首字母大写，没有下划线，常亮命名前面加k；

三、注释；
1、注释风格统一，变量可以选择不注释；
2、函数声明处注释描述函数功能，定义处描述函数实现；
3、出彩或者复杂的代码块前要加注释；比较隐晦的地方要在行尾空两格加入注释；

四、格式：
1、每一行代码的字符数不超过80。
2、尽量不要使用非ASCLL字符，使用时必须使用UTF-8格式。
3、只使用空格进行缩进，每次缩进2个空格；
4、垂直留白越少越好。水平留白因地制宜；
5、保持声明的统一性；

注：
1、使用指针时应尽量将其局部化，并且安全第一；
2、const能用则用，提倡const在前；