QT编程规范

序言：

     编程规范对于程序员对于公司是非常的重要的，因此我们在编码时也应该遵循一定的规范。

目录：

    一 、命名规范

    二 、内存管理规范

    三 、函数方法规范

    四 、 控制语句规范  

    五、  注释规范

    六、 排版规范

    七、版本管理规范

    八、界面编程

 词义解释：强制，推荐，参考分别表示规范的三个等级。

一、命名规范：

    【强制】1.类采用大驼峰格式，函数，变量及参数采用小驼峰命名，名称太长时可以缩写。

     多个单词缩写时，取首字母按顺序大写组成。一个长单词缩写时，应根据发音保留重音字母，       首字母大小重音字母小写。

    【强制】 2.常量(包含对话框ID）命名所有字母大写。

    【强制】3.接口类在前+字符（纯虚类）I。基类则在前+Base。

    【强制】4.函数命名规范：获取，查询用Get，设置用Set,增加用Add,插入用Insert，删除用              Delete。保存用Save。

    【强制】5.变量规范+（前缀）：

成员变量	m_
静态变量	s_
全局变量	g_

    【强制】6.变量规范+(类型）：

int short	n
float	f
double	d
char	c
unsigned char	uc
QString	s
指针	p

二、内存管理规范

    【强制】1.内存谁申请，谁释放

    【强制】 2.new申请内存之后。使用try catch捕获申请内存是否成功。原因：new申请内存可能失败

    【强制】3.变量（普通变量和指针）必须初始化。

    【强制】 4.使用指针前必须检查指针是否为空。

    【强制】5.指针new后必须delete且将指针赋值为nullptr。

    【强制】6.函数中分配的内存，函数退出之前要释放。

    【强制】7.多线程读写共用变量要加锁。

三、函数方法规范

   【强制】 1.函数参数必须在使用前校验（建议放在函数第一行）。包括数据范围校验，数据越界校验，异常指针校验。

   【推荐】2.增加函数错误处理流程，try catch，asset

   【参考】3.函数参数比较多时，应考虑用结构体代替

   【推荐】4.函数体长度应在80行内，且保证函数功能的单一性。

   【推荐】5.函数内代码层次应保持一致。

四、控制语句

     【强制】1.尽量上的使用if else 语句，多采用卫语句。

     【强制】2.不要在条件推断中运行其他复杂的语句。将复 杂逻辑推断的结果赋值给一个有意义的布尔变量名。以提高可读性。

五、注释规范

     【强制】1.模块注释包含信息：作者，日期，功能，依赖模块，调用流程

     【强制】2.类注释包含信息：作者，日期，功能，依赖类，调用流程

     【强制】  3.函数注释包含信息：作者，日期，功能，参数含义，返回值，其他。

     【强制】4.变量注释：注解内容要清楚准确不能有歧义。

六、排版规范

     【推荐】1.左大括号前不换行，左大括号后换行；右大括号前换行，右大括号后还有 else 等代码则不换行；表示终止右大括号后必须换行。

    【推荐】 2.左括号和后一个字符之间不出现空格。相同，右括号和前一个字符之间也不出现空格。

     【推荐】 3.if/for/while/switch/do 等保留字与左右括号之间都必须加空格

     【推荐】4.不论什么运算符左右必须加一个空格。

     【强制】 5.单行字符数限制不超过 120 个，超出须要换行，换行时遵循例如以下原则：

        运算符与下文一起换行，方法调用的点符号与下文一起换行，在括号前不要换行。

      【强制】6.使用空格进行对齐，禁止使用tab对齐。

七、版本管理规范

     1.VXX.XX.XX.XXXXXX.XXXXXX使用四位数进行版本管理，1-2位为主版本号，3-4位为分支版本号，5-6为次版本号，7-10为修订号1,11-15。

       【强制】主版本号：从1开始，产品更新换代时+1。之后版本号清零。

       【强制】分支版本号：从0开始，新建分支时+1，之后版本号清零。

       【强制】次版本号：从0开始，新增功能时+1，之后版本号清零

       【推荐】修订号1：年月日

       【推荐】修订号2： 小时分

八   界面编程

       【强制】1.尽量使用界面编辑工具编辑界面，做到所见即所得。避免使用源代码编辑界面。

       【强制】2.界面控件布局

                         2.1.同类界面的布局要统一，卡式、主细表、树形等同样格式要风格（大小，颜                                     色，样式）一致；

                         2.2.重要信息放在界面的核心位置，如：左上方位置，次要信息放在其它位置；

                         2.3.界面上近似内容要放在相近处，如：加框以示区别、或拉大与其它内容区域的                                 距离；

                         2.4.不同区域布局既要体现整体与局部区域的包含关系，又要注意局部区域与局部                                 区域的并列关系。可利用线条粗细，颜色深浅表现区域关系；

                         2.5.同类型区域与控件要保持上下左右对齐；

       【强制】3.色彩搭配

                          3.1 界面颜色一般使用三色搭配。三色搭配指不超过三种色相的色彩搭配原则。                                    三色搭配需要处理好色彩之间的主从关系，即设置主色、辅色、点缀色。色                                    彩 关系所占的比例面积可以设计为60%、30%、10%。

                          主色：决定整个UI界面的风格，主色一般在应用的LOG0、视觉面积较大的导航                                        栏 上使用。主色影响视觉传达效果。

                          辅色：帮助主色建立更加完整的视觉形象。如果一种颜色已经完美地与图形结                                          合，那么辅色就是没有必要的。辅色一般应用在各种控件、图标、插图上。

                                    辅色与主色是同类色或相近色。

                         点缀色：一般体现在细节上，多数是分散的，面积比例小。点缀色一般在一些需                                         要提示的小图标，或者需要突出的图形中使用。

                                   点缀色与主色是互补色或对比色。

       【强制】4.字体

                         4.1 字体颜色及大小应保持一致，除非文字有特殊作用。

                         4.2 字体选用区分背景的中性色配色。中性色配色指用中性的色彩为基调搭配，弱                                 化干扰。由黑色、白色及由黑白调和的各种深浅不同的灰色系列，称为无彩色                                 系，也称为中性色。