Qt Coding Style/zh

From Qt Wiki
Jump to navigation Jump to search


[toc align_right="yes" depth="2"]

Qt 编码风格

这是我们编写Qt代码时所使用的编码惯例的一个概述。数据是通过挖掘Qt源码、论坛、邮件列表以及与开发者的协作而收集起来的。

缩进

  • 采用4个空格
  • 空格,不要用TAB!

变量声明

  • 每行一个变量
  • 尽可能避免短的变量名(比如"a", "rbarr", "nughdeget")
  • 单字符的变量只在临时变量或循环的计数中使用
  • 等到真正需要使用时再定义变量
<br /> // Wrong<br /> int a, b;<br /> char *c, *d;

// Correct<br /> int height;<br /> int width;<br /> char *nameOfThis;<br /> char '''nameOfThat;<br />


以小写字符开头,后续单词以大写开头
* 避免使用缩写

<br /> // Wrong<br /> short Cntr;<br /> char ITEM_DELIM = '';

// Correct<br /> short counter;<br /> char itemDelimiter = '';<br />
  • 类名总是以大写开头。公有类以Q开头(QRgb),公有函数通常以q开头(qRgb)。

空白

  • 利用空行将语句恰当地分组
  • 总是使用一个空行(不要空多行)
  • 总是在每个关键字和大括号前使用一个空格
<br /> // Wrong<br /> if(foo){<br /> }

// Correct<br /> if (foo) {<br /> }<br />
  • 对指针和引用,在类型和*、&amp;之间加一个空格,但在*、&amp;与变量之间不加空格
    <br /> char '''x;<br /> const QString &amp;myString;<br /> const char''' const y = &quot;hello&amp;quot;;<br />
    
  • 二元操作符前后加空白
  • 类型转换后不加空白
  • 尽量避免C风格的类型转换
<br /> // Wrong<br /> char* blockOfMemory = (char* ) malloc(data.size());

// Correct<br /> char '''blockOfMemory = reinterpret_cast&amp;lt;char'''&gt;(malloc(data.size()));<br />

大括号

  • 基本原则:左大括号和语句保持在同一行:
<br /> // Wrong<br /> if (codec)<br /> {<br /> }

// Correct<br /> if (codec) {<br /> }<br />
  • 例外:函数定义和类定义中,左大括号总是单独占一行:
<br /> static void foo(int g)<br /> {<br /> qDebug(&quot;foo: %i&amp;quot;, g);<br /> }

class Moo<br /> {<br /> };<br />
  • 控制语句的body中只有一行时不使用大括号
<br /> // Wrong<br /> if (address.isEmpty()) {<br /> return false;<br /> }

for (int i = 0; i &lt; 10; +''i) {<br /> qDebug(&quot;%i&amp;quot;, i);<br /> }
<br /> // Correct<br /> if (address.isEmpty())<br /> return false;
<br /> for (int i = 0; i &lt; 10;i)<br /> qDebug(&quot;%i&amp;quot;, i);<br />


* 例外1:如果父语句跨多行,则使用大括号


<br /> // Correct<br /> if (address.isEmpty() || !isValid()<br /> || !codec) {<br /> return false;<br /> }<br />


* 例外2:在if-else结构中,有一处跨多行,则使用大括号


<br /> // Wrong<br /> if (address.isEmpty())<br /> return false;<br /> else {<br /> qDebug(&quot;%s&amp;quot;, qPrintable(address));<br />it;<br /> }
<br /> // Correct<br /> if (address.isEmpty()) {<br /> return false;<br /> } else {<br /> qDebug(&quot;%s&amp;quot;, qPrintable(address));<br />it;<br /> }
<br /> // Wrong<br /> if (a)<br /> if (b)<br /> …<br /> else<br /> …
<br /> // Correct<br /> if (a) {<br /> if (b)<br /> …<br /> else<br /> …<br /> }<br />


* 如果控制语句的body为空,则使用大括号


<br /> // Wrong<br /> while (a);
<br /> // Correct<br /> while (a) {}<br />


h2. 圆括号
* 使用圆括号将表达式分组


<br /> // Wrong<br /> if (a &amp;&amp; b || c)
<br /> // Correct<br /> if ((a &amp;&amp; b) || c)
<br /> // Wrong<br /> a'' b &amp; c

// Correct<br /> (a + b) &amp; c<br />

Switch 语句

  • case 和 switch 位于同一列
  • 每一个case必须有一个break(或renturn)语句,或者用注释说明无需break
<br /> switch (myEnum) {<br /> case Value1:<br /> doSomething();<br /> break;<br /> case Value2:<br /> doSomethingElse();<br /> // fall through<br /> default:<br /> defaultHandling();<br /> break;<br /> }<br />

断行

  • 保持每行短于100 个字符,需要时进行断行
  • 逗号放一行的结束,操作符放到一行的开头。如果你的编辑器太窄,一个放在行尾的操作符不容易被看到。
<br /> // Correct<br /> if (longExpression<br /> + otherLongExpression<br /> + otherOtherLongExpression) {<br /> }

// Wrong<br /> if (longExpression +<br /> otherLongExpression +<br /> otherOtherLongExpression) {<br /> }<br />

继承与关键字 `virtual`

  • 重新实现一个虚函数时,头文件中 放置 virtual 关键字。

通用例外

  • 如果它使你的代码看起来不好,你可以打破任何一个规则 。