Qt编程设计规范.docx

TOC\o1-3\h\z\uQt编程设计规范 1

一.概述 1

二.头文件 1

1)#define保护 2

2)头文件依赖 2

3)头文件包含次序 2

三.命名约定 2

1)通用命名约定 2

2)文件命名 3

3)类命名 3

4)变量命名 3

5)常量命名 4

6)函数命名 4

7)枚举命名 5

8)命名空间 5

9)结构体命名 6

四.代码注释 6

1)注释风格 6

2)类注释 7

3)函数注释 7

4)变量注释 8

5)实现注释 8

6)TODO注释 9

五.代码排版 10

1)行长度 10

2)缩进 10

3)空行 11

4)大括号 11

5)圆括号 13

六.重要原则 13

Qt编程设计规范

一.概述

良好的编程规范可以大幅提高一个程序的可读性、可理解性和可维护性。

本规范参考EffectiveC++中文版、GoogleC++编码规范及Qt编码风格。

二.头文件

1)#define保护

所有头文件都应该使用#define防止头文件被多重包含，命名格式为：ProjectName_FileName_H，例如：

#ifndefMAP_MAINWINDOW_H

#defineMAP_MAINWINDOW_H

……

#endif//MAP_MAINWINDOW_H

2)头文件依赖

使用前声明，尽量减少.h文件中#include的数量。

3)头文件包含次序

将包含次序标准化可增强可读性，次序如下：C库头文件、C++库头文件、其他库的头文件、项目内的头文件。

三.命名约定

1)通用命名约定

避免使用缩写。

2)文件命名

文件名全部小写，可以包含下划线，例如：

my_test_class.h

my_test_class.cpp

mytestclass.h

mytestclass.cpp

3)类命名

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

CMySystemWatcher

CClockBattery

4)变量命名

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

类成员变量需在变量名前加m_前缀，例如：

intm_myValue;

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

intmyValue=0;

尽量不要使用全局变量，以降低耦合。若使用能带来极大便利，命名时需在变量前加g_前缀，例如：

intg_myValue;

5)常量命名

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

constintMY_VALUE=0;

#defineMY_VALUE0

6)函数命名

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

intgetMyValue();

intsetMyeValue(intvalue)

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

setColor(constQColornew_color)

7)枚举命名

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

enumEnumMyColor?//枚举名

{

EnumWhite,????//枚举值

EnumBlack

};

8)命名空间

命名空间的名称是名词，每个单词以大写字母开头，且前两个单词是BaiDi，例如：

namespaceBaoDiProject{}

9)结构体命名

结构体中只定义变量，不定义函数。

结构体名是名词，每个单词以大写字母开头。

结构体成员名词，首单词以小写字母开头，后续单词以大写字母开头。例如：

structMyColor

{

???boolisMyColor;

???intwhite;

};

四.代码注释

1)注释风格

使用//或/**/，统一就行。一般情况下，源程序有效注释量必须在20%以上，不易理解的地方都需加上注释，注释不宜太多也不能太少。

2)类注释

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

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

**Copyright(C),2015-2025,BaodiTechnology.

**Version:

**Author:??????????