Qt编程设计规范

Qt 编程设计规范 1一.概述 1二.头文件 11）#define 保护 22）头文件依赖 23）头文件包含次序 2三.命名约定 21）通用命名约定 22）文件命名 33）类命名 34）变量命名 35）常量命名 46）函数命名 47）枚举命名 58）命名空间 59）结构体命名 6四.代码注释 61）注释风格 62）类注释 73）函数注释 74）变量注释 85）实现注释 86）TODO 注释 9五.代码排版 101）行长度 102）缩进 103）空行 114）大括号 115）圆括号 13六.重要原则 13Qt 编程设计规范一.概述良好的编程规范可以大幅提高一个程序的可读性、可理解性和可维护性本规范参考 EffectiveC++中文版＞GoogleC++编码规范及 Qt 编码风格。二.头文件1) #define 保护所有头文件都应该使用#define 防止头文件被多重包含，命名格式为:〈ProjectName〉_〈FileName〉_H，例如：#ifndefMAP_MAINWINDOW_H#defineMAP_MAINWINDOW_H#endif//MAP_MAINWINDOW_H2）头文件依赖使用前声明，尽量减少.h 文件中#include 的数量。3）头文件包含次序将包含次序标准化可增强可读性，次序如下:C 库头文件、++库头文件、其他库的头文件、项目内的头文件。三.命名约定1）通用命名约定避免使用缩写。2）文件命名文件名全部小写，可以包含下划线，例如：my_test_class.hmy_test_class.cppmytestclass.hmytestclass.cpp3）类命名类名是名词，每个单词以大写字母开头，不包含下划线，且名前加大写字母 C,例如：CMySystemWatcherCClockBattery4）变量命名变量名是名词，首单词以小写字母开头，后续单词以大写字母开头。每行一个变量，单字符的变量只在临时变量或循环计数中使用。类成员变量需在变量名前加 m_前缀，例如：intm_myValue;局部变量等到需要使用时再定义变量，且定义时必须初始化，整数用 0，实数用 0.0,指针用 NULL，字符（串）用’\0'。例如：intmyValue=0;尽量不要使用全局变量，以降低耦合。若使用能带来极大便利，命名时需在变量前加 g_前缀，例如：intg_myValue;5）常量命名常量不含前缀且应该大写，单词间有下划线，包括全局常量和宏定义，例如：constintMY_VALUE=0;#defineMY_VALUE06）函数命名函数名是动词或含有动词的短语，首单词以小写字母开头，后续单词以大写字母开头，例如：intgetMyValue（）;intsetMyeValue(intvalue)函数参数所有字母小写，单词间有下划线，若为非基本数据类型，使用const 引用，例如：setColor(constQColor&new_color)7) 枚举命...