C++命名规范总结

C++命名规范

​ 如果想要有效的管理一个稍微复杂一点的体系，针对其中事物的一套统一、带层次结构、清晰明了的命名准则就是必不可少而且非常好用的工具。

​ 在软件开发这一高度抽象而且十分复杂的活动中，命名规则的重要性更显得尤为突出。一套定义良好并且完整的、在整个项目中统一使用的命名规范将大大提升源代码的可读性和软件的可维护性。

命名规范的整体规则

在引入细节之前，先说明一下命名规范的整体原则：

规则	说明
同一性	在编写一个子模块或派生类的时候，要遵循其基类或整体模块的命名风格，保持命名风格在整个模块中的同一性。
标识符组成	标识符采用英文单词或其组合，应当直观且可以拼读，可望文知意，用词应当准确。
最小化长度 && 最大化信息量原则	在保持一个标识符意思明确的同时，应当尽量缩短其长度。
避免过于相似	不要出现仅靠大小写区分的相似的标识符，例如i与I，function与Function等等。
避免在不同级别的作用域中重名	程序中不要出现名字完全相同的局部变量和全局变量，尽管两者的作用域不同而不会发生语法错误，但容易使人误解。
正确命名具有互斥意义的标识符	用正确的反义词组命名具有互斥意义的标识符，如：nMinValue和nMaxValue，GetName() 和 SetName() 等。
避免名字中出现数字编号	尽量避免名字中出现数字编号，如Value1,Value2等，除非逻辑上的确需要编号。这是为了防止程序员偷懒，不肯为命名动脑筋而导致产生无意义的名字（因为用数字编号最省事）。

类/接口

​ 除了异常类等个别情况（不希望用户把该类看作一个普通的、正常的类之情况）外，C++类/接口的命名应该遵循以下准则：

C++类/接口的命名
类的名称都要以大写字母C开头，后跟一个或多个单词。接口以大写I开头，代表Interface。为便于界定，每个单词的首字母要大写。

推荐的组成形式
类的命名推荐用 “名词” 或“形容词＋名词”的形式，例如：CAnalyzer，CFastVector，IFactory 等。

函数

​ 函数的名称由一个或多个单词组成。为便于界定，每个单词的首字母要大写。最长不得超过20个字符。

组成形式
全局函数应当使用“动词”或者“动词＋名词”（动宾词组）的形式。例如：gGetName(), gDrawBox()。
类成员函数应当只使用”动词“，被省略掉的名词就是对象本身。例如：
box->Draw();。

全局函数
以小写前缀g开头；以其所在程序集或所属小组名称简写开头，例如Afx；定义了命名空间的全局函数则可以无需前缀。

保护成员函数
保护成员函数的开头应当加上一个下划线_以示区别，例如：_SetState() 等。

私有成员函数
类似地，私有成员函数的开头应当加上两个下划线__，例如：__DestroyImp() 等。

虚函数
虚函数习惯以Do开头，如：DoRefresh(), _DoEncryption() 等。

回调和事件处理函数
回调和事件处理函数习惯以单词On开头。例如：_OnTimer(), OnExit() 等。

变量

​ 变量应该是程序中使用最多的标识符了，变量的命名规范可能是一套C++命名准则中最重要的部分。

​ 变量名由 作用域前缀＋类型前缀＋一个或多个单词＋数据结构标识 组成，为便于界定，每个单词的首字母要大写。其中对于“数据结构标识”可以作为类型前缀使用，也可以作为后缀使用。对于某些用途简单明了的局部变量，也可以使用简化的方式，如：i, j, k 。

作用域前缀
作用域前缀标明一个变量的可见范围。作用域可以有如下几种：

前缀	**说明 **
无	局部变量
m_	类的成员变量（member）
sm_	类的静态成员变量（static member）
s_	静态变量（static）
g_	外部全局变量（global）
sg_	静态全局变量（static global）
gg_	进程间共享的共享数据段全局变量（global global）

类型前缀
类型前缀标明一个变量的类型，可以有如下几种：

**前缀 **	说明
n	整型和位域变量（number）
l	长整型（long）
u	无符号型（unsigned）
ch	字符型变量（char）
str	字符串型变量（char[]，string）
b	布尔型变量（bool）
f	浮点型变量（float）
d、lf	双精度浮点型变量（double）
p	指针型变量和迭代子（pointer）
lp	长指针
pfn	特别针对指向函数的指针变量和函数对象指针（pointer of function）
c	常量（constant）
lpsz	LPSTR、LPCSTR、LPCTSTR
by	BYTE
w	WORD
dw	DWORD
h	handle，Window句柄对象
it	迭代器（iterator）

可添加数字说明变量位数，例如：m_u16Number，n32Temp 等。

数据结构标识

类型前缀	后缀	说明
array	Array	数组
map	Map	映射
set	Set	集合
list	List	列表
que	Queue, Que	队列
vec	Vector, Vec	向量

推荐的组成形式
变量的名字应当使用“名词”或者“形容词＋名词”。例如：nCode，m_fPostionX，mapTemp，m_nResultList ，g_strFileNameArray等。

常量

​ 常量名由类型前缀＋全大写字母组成，单词间通过下划线来界定，类型前缀的定义与变量命名规则中的相同。

例如：cDELIMITER，nMAX_BUFFER。

结构体、宏、枚举、联合

​ 结构体、宏、枚举、联合命名全部由 前缀＋大写 字母组成，单词间使用下划线界定。

结构体
加小写前缀"tag"，之后以大写字母开头。

typedef struct tagPOINT
{
    int x;
    int y;
} POINT;

宏

#define MAXNUMBER 100

枚举变量

typedef enum _FILE_OPEN_MODE
{
    OPEN_READONLY,
    OPEN_READWRITE
} FILE_OPEN_MODE;

联合体

typedef union _VARIANT
{
    char unichVal;
    int uninVal;
    float uniftVal;
} VARIANT;

参考文献：
https://www.cnblogs.com/xinhua219/p/10440825.html
https://blog.csdn.net/qq_36155922/article/details/52665726