首页 > 代码库 > Qt C++编程规范

Qt C++编程规范

2024-09-08 15:27:13   218人阅读

一，文件命名规则。

1，一个类对应一个.h和一个.cpp文件，文件名与类名相同，大小写保持一致。

【例外】 一个类与其他类有紧密关系，或者其他类只为主类服务(用到一个类时，另一个必须用到)，则可以写入到同一.h文件，或者嵌入到主类中。

2，扩展名 头文件用.h，c源文件用.c，c++源文件用.cpp。

3，文件名字用类名，若果没有类，则可采用所有首字母大写形式。

4，头文件的排列顺序

 1 //1，头文件开头注释，包含作者，功能叙述，改动，时间。
 2 /*
 3 name : MyClass
 4 author : ***
 5 note : 
 6 */
 7 
 8 //2，头文件防止重复包含的宏
 9 #ifndef __MYCLASS_H__
10 #define __MYCLASS_H__
11 
12 //3，包含的头文件
13 #include <QWidget>
14 
15 //4，宏定义
16 #define CAMERA_DEVICE "/dev/video0"
17 
18 //5，常量
19 static char *my_str="this is my first Blog";
20 
21 //6，其他类型声明，外部变量应用，typedef重命名类型。
22 class QPushButton;
23 extern int mu_number;
24 
25 //7，结构体，枚举，联合体
26 struct MyPictureInfo{
27 
28 };
29 
30 enum MySeason{
31 
32 };
33 
34 union MyBook{
35 
36 };
37 
38 //8，类的定义
39 class MyClass{
40 
41 };
42 
43 //9，反重复头文件宏结束，及其注释
44 #endif //MyClass end

5，源文件的排列顺序

技术分享 
//1，文件开头注释

//2，包含的头文件

//3，静态变量

//4，变量（全局）的定义

//5，静态函数的声明/定义

//6，类的函数的实现，按照在.h中定义的顺序实现，

//7,文件结尾注释
View Code

6，头文件包含，系统头文件，其他sdk库，第三方库用<>使用，内部自定义头文件用""使用。

【1】此处使用避免使用相对路径，可以使用INCLUDE变量进行头文件目录指定。

【2】引用头文件顺序依次为，系统头文件，第三方库头文件，Qt头文件，自定义头文件。

【3】使用c头文件，用extern "C"{}进行引用。

【4】避免使用多余的头文件，若果多次修改导致某些头文件无用，请及时删除。

【5】可用适当通过前置声明避免过多引入头文件。

【6】不要再头文件定义变量，看是否造成内存使用。

【7】头文件不要使用命名空间，可能两个命名空间有同名函数，会导致运行出错(这种错误难查找)。若要使用，请在函数前面加上作用域。或者在类内部某一范围引入命名空间。

 

Qt C++编程规范


联系
我们