C++/Qt编程规范

一、头文件规范

在编码中对头文件的引用，建议按照以下顺序进行：
1)类定义头文件
2)其他库头文件
a)Qt模块头文件
b)XTAL平台框架模块头文件
c)第三方库头文件
d)自定义公共库头文件

二、变量命名

除项目中的变量名，函数名使用小驼峰命名法，其他都用大驼峰
项目名称：一般以项目名称对应的每个英文单词的首字母大写组成的简称来命名

• 针对以“private”关键字定义的类私有成员变量，建议以”m_“+变量描述的方式进行命名，变量描述遵循小驼峰命名方式，例如：m_demoVar，m_fileName等;
  注：为了代码的可靠性，类的成员变量必须都进行初始化。
• 针对以“public”关键字定义的类公有成员变量，建议以”g_“+变量描述的方式进行命名，变量描述遵循小驼峰命名方式，例如：g_demoVar，g_filePath等;
• 全局常量指的是在整个项目范围内都恒定不变的常量定义，对于这种类型的常量，建议名称用全英文大写，例如：

static const int VAR = 1;

• 标识符（“宏名”）：应该尽量用能够代表宏的含义的若干英文字符（或者缩写）来命名，且全部大写，如果宏对应的内容是字符串，则字符串内容与“宏名”内容一致，且字符小写，例如：

#define PI 3.14
#define LOGIN_STATUS_SUCCESS "login_status_success"

三、信号和槽

• 所有信号函数以英文单词“signal”的首部（sig）+ 信号功能的英文单词的方式进行命名，例如:一个表示数据加载完成的信号可以写成：sigDataLoadFinishd()；而一个表示文件打开成功的信号函数可以写成sigFileOpenSuccess()。
  【注】：在代码中发送某个信号时，建议统一加上关键字“emit”进行调用，例如:
  emit sigDataLoadFinishd()；
• 所有槽函数/事件处理函数函数以“on”+ 对应信号/事件的英文单词的方式进行命名，例如:一个表示数据加载完成信号的槽函数可以写成：onDataLoadFinishd()；而一个表示处理指令发送事件的处理函数可以命名为：onCmdSendEvent()。

四、注释

• 注释内容采用英文进行书写
• 在头文件和代码文件的最上部分添加关于该文件的内容（主要是类）的说明性文字，主要包括：
  a)Project:文件所属工程名称
  b)Flie：当前文件名（建议与文件中定义的类类名保持一致）
  c)Spec：单词spectification缩写，该文件的主要功能
  文件说明的相关注释采用块注释(/* */)的格式，其具体格式规范如下图所示：
  
• 函数注释主要对函数的功能，以及参数及返回值等进行说明，注释位置写在代码文件函数定义位置的上方，采用块注释(/* */)的方式，注释内容主要包括：
  a)Class:函数所属类名
  b)Func:单词Function缩写，表示函数名
  c)Spec: 单词spectification缩写，函数功能说明
  d)Para:函数参数列表说明，存在多个参数时，每个参数占一行，以@参数名的方式进行说明
  e)Return:函数返回值
  其具体格式规范如下图所示：
  
• 变量注释主要对变量的功能，以及取值范围等相关进行说明，采用行注释的方式进行，其具体格式规范如下图所示：