必须遵循几种简单的C++命名规则:
1.在名称中只能使用字母字符、数字和下划线(_)
2.名称的第一个字符不能是数字
3.区分大写字符与小写字符
4.不能将C++关键字用作名称
5.以两个下划线或下划线和大写字母打头的名称被保留给实现(编译器及其使用的资源)使用。以一个下划线开头的名称被保留给实现,用作全局标识符。
6.C++对于名称的长度没有限制,名称中所有的字符都有意义,但有些平台有长度限制。
除了要遵循C++中的命名规则外,如果想要有效的管理一个稍微复杂一点的体系,针对其中事物的一套统一、带层次结构、清晰明了的命名准则就是必不可少而且非常好用的工具。
命名法则
目前,业界共有四种命名法则:驼峰命名法、匈牙利命名法、帕斯卡命名法和下划线命名法,其中前三种是较为流行的命名法。
- 驼峰命令法,正如它的名称所表示的那样,是指混合使用大小写字母来构成变量和函数的名字。
示例:printEmployeePaychecks() - 匈牙利命名法,通过在变量名前面加上相应的小写字母的符号标识作为前缀,标识出变量的作用域、类型等。这些符号可以多个同时使用,顺序是先m_(成员变量)、再指针、再简单数据类型、再其它。这样做的好处在于能增加程序的可读性,便于对程序的理解和维护。匈牙利命名法关键是:标识符的名字以一个或者多个小写字母开头作为前缀;前缀之后的是首字母大写的一个单词或多个单词组合,该单词要指明变量的用途。
示例:m_lpszStr,表示指向一个以0字符结尾的字符串的长指针成员变量。 - 帕斯卡命名法(也叫大驼峰命名),与驼峰命名法类似,二者的区别在于:驼峰命名法是首字母小写,而帕斯卡命名法是首字母大写,
示例:DisplayInfo(); string UserName - 下划线命名法,常用于python的编程命名中,示例:print_employee_paychecks()
命名的基本原则
规则 | 说明 |
---|---|
同一性 | 在编写一个子模块或派生类的时候,要遵循其基类或整体模块的命名风格。 |
望文知意 | 标识符采用英文单词或其组合,应当直观且可以拼读,可望文知意,用词应当准确。在变量名中加入其他的信息,即描述变量类型或内容的前缀。例如,将整型变量myWeight命名为nMyWeight,其中前缀n用来表示整数值str或sz表示以空字符结束的字符串b表示布尔值p表示指针c表示单个字符 |
最小化长度 && 最大化信息量原则 | 在保持一个标识符意思明确的同时,应当尽量缩短其长度。 |
避免过于相似 | 不要出现仅靠大小写区分的相似的标识符,例如i与I,function与Function等等。 |
避免在不同级别的作用域中重名 | 程序中不要出现名字完全相同的局部变量和全局变量,尽管两者的作用域不同而不会发生语法错误,但容易使人误解。 |
正确命名具有互斥意义的标识符 | 用正确的反义词组命名具有互斥意义的标识符,如:nMinValue和nMaxValue,GetName() 和 SetName() 等。 |
避免名字中出现数字编号 | 尽量避免名字中出现数字编号,如Value1,Value2等,除非逻辑上的确需要编号。这是为了防止程序员偷懒,不肯为命名动脑筋而导致产生无意义的名字(因为用数字编号最省事) |
综上所述,我们宜采用匈牙利命名法。
类/接口
除了异常类等个别情况(不希望用户把该类看作一个普通的、正常的类之情况)外,C++类/接口的命名应该遵循以下准则:
C++类/接口的命名
类的名称都要以大写字母C开头,后跟一个或多个单词。接口以大写I开头,代表Interface。为便于界定,每个单词的首字母要大写。
推荐的组成形式
类的命名推荐用 “名词” 或“形容词+名词”的形式,例如:CAnalyzer,CFastVector,IFactory 等。
函数的名称由一个或多个单词组成。为便于界定,每个单词的首字母要大写。最长不得超过20个字符。
组成形式:
全局函数应当使用“动词”或者“动词+名词”(动宾词组)的形式。例如:gGetName(), gDrawBox()。定义了命名空间的全局函数则可以无需前缀。
类成员函数应当只使用”动词“,被省略掉的名词就是对象本身。例如: box->Draw();。
变量
变量应该是程序中使用最多的标识符了,变量的命名规范可能是一套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;
构建自己的命名规范
结合以上命名规则和自己的习惯构建一套适合自己的命名规范。
类型 | 命名规则 | 示例 |
---|---|---|
普通函数 | 大驼峰法 | GetName() |
成员函数 | 小驼峰法 | getName() |
变量 | 匈牙利命名法 | m_lpszStr,m_nResultList |
类/结构体 | 大驼峰法 | class MyClass |
接口 | I+大驼峰法 | class IMyInterface |
常量 | 前缀+大写 | nMaxValue |
宏/枚举 | 大写+下划线法 | DEBUG_PRO |
注:以上为主要遵循的命名规则,必要情况下可以适当联合下划线法进行命名。
参考文献
https://blog.csdn.net/qq_40935205/article/details/127929000