C++代码匈牙利命名规范

时间:2024-09-25 21:34:56
一、类
除了异常类等个别情况(不希望用户把该类看作一个普通的、正常的类之情况)外,C++类/结构的命名应该遵循以下准则:
C++类的命名
  
类的名称都要以大写字母“C”开头,后跟一个或多个单词。为便于界定,每个单词的首字母要大写。
类的命名推荐用"名词"或"形容词+名词"的形式,例如:"CAnalyzer", "CMonkeyVector" ....
传统C结构体的命名
  
传统的C结构体只是一种将一组数据捆绑在一起的方式,其名称全部由大写字母组成,单词间使用下划线界定,例如:"SERVICE_STATUS",
"DRIVER_INFO" ....
二、函数
普通函数的命名
  
函数的名称由一个或多个单词组成。为便于界定,每个单词的首字母要大写。函数名应当使用"动词"或者"动词+名词"(动宾词组)的形式。例如:"GetName()",
"SetValue()", "Erase()", "Reserve()" ....
保护/私有成员函数
  
保护成员函数的开头应当加上一个下划线“_”以示区别,例如:"_SetState()" ....
虚函数
   虚函数习惯以“Do”开头,如:"DoRefresh()",
"_DoEncryption()" ....
回调和事件处理函数
  
回调和事件处理函数习惯以单词“On”开头。例如:"_OnTimer()", "OnExit()" ....
三、变量
变量应该是程序中使用最多的标识符了,变量的命名规范可能是一套C++命名准则中最重要的部分。变量名由作用域前缀+类型前缀+一个或多个单词组成。为便于界定,每个单词的首字母要大写。变量的名字应当使用"名词"或者"形容词+名词",例如:"nCode",
"m_nState","nMaxWidth" ,对于某些用途简单明了的局部变量,也可以使用简化的方式,如:i, j,
....
作用域前缀   
作用域前缀标明一个变量的可见范围。作用域可以有如下几种:
前缀   
说明
无   
局部变量
m_   
类的成员变量(member)
sm_   
类的静态成员变量(static member)
s_   
静态变量(static)
g_   
外部全局变量(global)
sg_   
静态全局变量(static global)
gg_   
进程间共享的共享数据段全局变量(global global)
类型前缀   
类型前缀标明一个变量的类型,可以有如下几种:
前缀   
说明
n   
整型和位域变量(number)
e   
枚举型变量(enumeration)
c   
字符型变量(char)
b   
布尔型变量(bool)
f   
浮点型变量(float)
p   
指针型变量和迭代子(pointer)
pfn   
特别针对指向函数的指针变量和函数对象指针(pointer of function)
g   
数组(grid)
i   
类的实例(instance)
对于经常用到的类,也可以定义一些专门的前缀,如:std::string和std::wstring类的前缀可以定义
为"str",std::vector类的前缀可以定义为"v"等等。类型前缀可以组合使用,例如"gc"表示字符数组,"ppn"表示指向整型的指针的
指针等等。
四、常量
常量的命名由全大写字母组成,单词间通过下划线来界定,如:DELIMITER, MAX_BUFFER ....
五、枚举、联合、typedef
枚举、联合、typedef的命名 
全大写字母组成,单词间通过下划线来界定,如:FAR_PROC, ERROR_TYPE ....
六、宏、枚举值
宏、枚举值的命名由全大写字母组成,单词间通过下划线来界定,如:ERROR_UNKNOWN, OP_STOP ....