遵循的C++代码规范（个人项目）

C++ 命名规范（个人）

1. 类/结构

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

C++类/结构的命名类的名称都要以大写字母“C”开头，后跟一个或多个单词。为便于界定，每个单词的首字母要大写。推荐的组成形式类的命名推荐用**”名词”或“形容词＋名词”**的形式，例如：CAnalyzer, CFastVector。

不同于C++类的概念，传统的C结构体只是一种将一组数据捆绑在一起的方式。传统C结构体的命名规则为：传统C结构体的命名传统C结构体的名称全部由大写字母组成，单词间使用下划线界定，例如：SERVICE_STATUS, DRIVER_INFO。

2. 函数

函数的命名	函数的名称由一个或多个单词组成。为便于界定，每个单词的首字母要大写
推荐的组成形式	函数名应当使用”动词”或者”动词＋名词”（动宾词组）的形式。例如：GetName(), SetValue(), Erase(), Reserve()
保护成员函数	保护成员函数的开头应当加上一个下划线”_”以示区别，例如：SetState()
私有成员函数	类似地，私有成员函数的开头应当加上两个下划线__，例如：__DestroyImp()
虚函数	虚函数习惯以“Do”开头，如：DoRefresh(), _DoEncryption()
回调和事件处理函数	回调和事件处理函数习惯以单词“On”开头。例如：_OnTimer(), OnExit()

3. 变量

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

• 变量名由作用域前缀 + _ + 类型前缀 + 一个或多个单词组成。变量用小写字母开头的单词组合而成，第二个单词的首字母要大写。例如：int nDrawMode。变量最长不得超过20个字符。

例外：对于某些用途简单明了的局部变量，也可以使用简化的方式，如：i, j, k, x, y, z

• 组成形式：变量的名字应当使用”名词”或者”形容词＋名词”。例如：nCode, m_nState，nMaxWidth，oldValue，newValue。

• 作用域前缀：

  前缀	说明	例子
  无	局部变量	i,j,k,n
  m_	类的成员变量（member）	int m_width
  ms_	类的静态成员变量（static member）	static int ms_initValue
  s_	静态变量（static）	static int s_initValue
  g_	外部全局变量（global）	int g_howManyPeople
  sg_	静态全局变量（static global）
  gg_	进程间共享的共享数据段全局变量（global global）

  说明：作用域前缀不同于下面的类型前缀，应该坚决执行。原因是：

  1）变量作用域和链接性改变的情况是很少的，例如，很少的情况下会把一个成员变量改成静态变量;

  2）编程中使用的工具常常不会直观的显示变量的作用域和链接性。

• 类型前缀

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

  前缀	说明	例子
  b	布尔型变量（bool, BOOL）	bEnable
  ch	字符型变量（char TCHAR）	chName
  lpsz	LPSTR、LPCSTR、LPCTSTR	lpszName
  n	整型和位域变量（int, UINT, __int32,__int64）	nLength
  l	long	lOffset
  by	BYTE
  w	WORD	wPos
  dw	DWORD	dwRange
  f	浮点型变量（float）
  d	double
  p	指针型变量和迭代子（pointer）	pDoc
  lp	远指针
  e	枚举型变量（enumeration）
  pfn	特别针对指向函数的指针变量和函数对象指针（pointer of function）
  g	数组（grid）
  h	handle Windows对象句柄	hWnd

4. 常量

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

5. 结构体、宏、枚举变量、联合体

全部由前缀 + 大写字母组成，单词间使用下划线界定。

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

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

• 宏：大写字母组成，单词间使用下划线界定。

  #DEFINE MAX_NUMBER 100

• 枚举变量：加小写前缀”enum”。

  typedef enum enumFILE_OPEN_MODE
  {
  OPEN_READONLY，
  
  OPEN_READWRITE
  
  }FILE_OPEN_MODE;

• 联合体：加小写前缀”uni”。

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