qt编码规范_免费下载

《qt编码规范_免费下载》由会员上传分享，免费在线阅读，更多相关内容在应用文档-天天文库。

1、目录1概述12重要惯例12.1包含的头文件12.2变量命名原则12.3空白42.4大括号62.5圆括号92.6switch语句92.7断行102.8继承与virtual122.9注释123重要原则123.1可读性比精炼更重要123.2相似的类应该具有相似的接口13131概述良好的编程规范可以大幅提高一个程序的可读性、可维护性。编码规范是大家达成一致的约定，这样大家的代码就可以互相看懂，维护起来更容易，思想更畅快的交流，经验更快的得到传播。代码规范不是束缚程序员的桎梏，应该知道，不遵守规范的个性的代码并不代表程序员的性格，并不能张扬个性。软件开发领域并没有一个公认

2、的、统一的编程规范，不同的软件开发项目或者组织会采用不同的编程规范。因此，在利用QT编程时，其编程规范与部门现采用的C++编程规范有所不同。本文档是参照C++编程规范、JAVA编程规范对QT编码惯例和QT编码风格进行适当修改后，形成的一份适合于QT开发的总结性文档。可读性、可理解性是代码的重要方面，本文档主要围绕如何去产生规范易懂的代码。2重要惯例2.1包含的头文件在公用的头文件中，头文件包含总是使用这样的形式：#include2.2变量命名原则（1）每行一个变量；（2）尽可能避免短的变量名；13（3）单字符的变量只在临时

3、变量或循环的计数中使用；（4）等到真正需要使用时再定义变量；//Wronginta,b;charc,d;//Correctintheight;intwidth;charnameOfThis;charnameOfThat;（5）以小写字符开头，后续单词以大写开头；（6）避免使用缩写，即使对于“previousprev”这样广为接受的缩写形式，Qt也不予采纳，因为这要求程序员记忆哪些单词被缩写、哪些没有被缩写；//WrongshortCntr;charITEM_DELIM='/t';//Correctshortcounter;charitemDelimiter='/

4、t';（7）类名总是以大写开头，以字母Q开始，表示该类是Qt软件包中定义的类，自定义的类可以以大写字母C开头。此时，第二个字母也应该是大写的。而且，类的名字应该是一个名词，比如QFileSystemWatcher。13（8）函数名字以小写字母开始，应该是一个动词或者含有动词的短语，比如collidesWithItem()。（9）全局常量名字中的字母都应该大写，比如Q_BIG_ENDIAN。（10）枚举常量的名字应该含有枚举类型的信息。这是由于枚举常量在C++程序中可被直接使用，如果其名字过于简单，可能会导致歧义。例如：//WrongenumCaseSensiti

5、vity{Insensitive,Sensitive};由于有上下文，枚举常量Insensitive及Sensitive在被定义时并没有任何歧义。然而，当它们在程序其他地方被引用时，程序的读者难以理解它们的含义。因此，应该在它们的名字中嵌入枚举类型的信息，比如：//CorrectenumCaseSensitivity{CaseInsensitive,CaseSensitive};（11）如果某个数据成员具有布尔类型，读取该数据的成员函数应该以“is”打头，比如isEmpty()、isMovingEnabled()。然而，如果该数据成员的名字是复数形式的，则不需要

6、加任何前缀，比如scrollBarsEnabled()。补充：在Qt例子编写中，对变量名有如下建议：（1）成员变量前不要加"m_"或其他什么东西（2）如果参数名和成员变量名发生冲突，使用"this->"解决voidMyClass::setColor(constQColor&color;){this->color=color;}13或voidMyClass::setColor(constQColor&newColor;){color=newColor;}（3）避免使用意义不明确的字符：//WrongvoidMyClass::setColor(constQColor

7、&c){color=c;}注意：在构造函数中，会遇到同样的问题。但无论你信与不信，下面的可以工作。MyClass::MyClass(constQColor&color):color(color){}2.3空白（1）采用4个空格；（2）空格，不要用TAB！（3）利用空行将语句恰当地分组；（4）总是使用一个空行(不要空多行)；13//Correctif(foo){}（5）对指针和引用，在类型和、&之间加一个空格，但在、&与变量之间不加空格；charx;constQString&myString;constcharconsty="hello";（6）二元操作符前后加空

8、白；（7）类型转换后不加