Qt学习笔记：编程规范性问题

良好的编程规范可以提高程序的 可读性和可维护性（参考资料：https://blog.csdn.net/caoshangpa/article/details/61635525）

1、所有的头文件都应该使用#define防止被多重包含：

#ifndef MAINWINDOW_H
#define MAINWINDOW_H
--------------
#endif // MAINWINDOW_H

2、尽可能减少头文件（.h）中的#include的数量

3、头文件包含 次序：c库头文件、c++库头文件、其他库头文件、项目内的头文件

4、命名约定：

 a、通用命名约定：避免使用缩写

b、文件命名：文件名全部小写，可以包含下划线

c、类命名：类名是名词，每个单词以大写字母开头，不包含下划线，且名词前加大写字母C，如：CClockBattery

d、变量命名：变量名是名词，首单词以小写字母开头，后续单词以大写字母 开头，每行一个变量，单字符的变量 只在临时变量或循环计数中使用

类成员变量需要在变量名前 加m_前缀：int m_myValue；

局部变量等到需要使用时再定义变量，且定义时必须 初始化，整数用0，实数用0.0，指针用NULL，字符（串）用‘\0’，如：

int myValue=0;

尽量不要使用全局变量，必须使用时加前缀g_，如：int g_myValue；

e、常量命名：常量不含前缀且应该大写，单词间有下划线，包括全局常量和宏定义，如：

const int MY_VALUE=0;

#define MY_VALUE 0

f、函数命名：函数名是动词或含有动词的短语，首单词以小写字母开头，后续单词以大写字母开头，例如：

int getMyValue();

int setMyValue(int value);

函数参数 所有字母小写，单词间有下划线，若为非基本数据类型，使用const引用，如：setColor(const QColor&new_color)

g、枚举命名：

枚举名和枚举值都是 名词，每个单词以大写字母开头，且第一个单词是Enum，如:

enum EnumMyColor  //枚举名

{

EnumWhite;  //枚举值

EnumBlack;

}

h、命名空间：

i、结构体命名：结构体中只定义变量不定义函数；结构体是名词，每个单词以大写字母开头；结构体成员名词，首单词以小写字母开头，后续 单词以大写字母开头，如：

struct MyColor

{

bool isMyColor；

int white；

}

5、代码注释：

1）：注释风格： 统一用//或/* ------*/

2）：类注释：类的头文件顶部 需添加说明性注释，包括版权说明、版本号、作者、生成 日期、类的功能描述等.

/*************************************

 * *Copyright(C),2015-2025，Baodi Technology.

 * *Version：

 * *Author:

 * *Data:

 * *Description:

 * **********************************/

3）函数注释：重要函数头部应该进行注释，包括函数名、函数功能描述、输入参数、输出参数、返回值等

/*************************************

 * *Function: //函数名称

 * *Description://函数功能描述

 * *Input://输入参数说明，包括每个参数的作用、取值说明

 * *Output://对输出参数的说明

 * *Return：//函数返回值说明

 * *Others://其他说明

 * **********************************/

4）变量注释：需要说明变量时，变量注释 位于变量上方

5）实现注释：对于实现代码中巧妙的、晦涩的、重要的地方加以注释，出彩或复杂的代码块上方要加以注释

6、代码排版

1）行长度：较长的语句要分成多行书写， 长表达式要在较低优先级操作符处 划分新行，操作符放在新行之首，逗号放在 一行的结束，划分出的新行要适当进行缩进，使得排版整齐，语句可读：

2）缩进：使用 四个空格进行代码缩进， 不要用tab键

 预处理指令不要 缩进，从定格开始，如：

if(isActive())

{

#if DISASTER_PENDING

    dropEverything();

#endif

    backToNormal();

}

3）空行：

在相对独立的代码块之间必须加一行空行

4）大括号：大括号永远单独占一行，不要跟在语句后面，如：

if()

{

}

5)圆括号：使用圆括号将表达式分组，即使 运算符的优先级 相同，也要用 圆括号进行分组，如：

if((a&&b)||c)

7、重要原则

正确性>稳定性>可测试性>可读性>全局效率>局部效率>个人 习惯