Qt Coding Style/zh
From Qt Wiki
Contents
Qt 编码风格
这是我们编写Qt代码时所使用的编码惯例的一个概述。数据是通过挖掘Qt源码、论坛、邮件列表以及与开发者的协作而收集起来的。
缩进
- 采用4个空格
- 空格,不要用TAB!
变量声明
- 每行一个变量
- 尽可能避免短的变量名(比如"a", "rbarr", "nughdeget")
- 单字符的变量只在临时变量或循环的计数中使用
- 等到真正需要使用时再定义变量
// Wrong
int a, b;
char *c, *d;
// Correct
int height;
int width;
char *nameOfThis;
char nameOfThat;
以小写字符开头,后续单词以大写开头
- 避免使用缩写
// Wrong
short Cntr;
char ITEM_DELIM = ;
// Correct
short counter;
char itemDelimiter = ;
- 类名总是以大写开头。公有类以Q开头(QRgb),公有函数通常以q开头(qRgb)。
空白
- 利用空行将语句恰当地分组
- 总是使用一个空行(不要空多行)
- 总是在每个关键字和大括号前使用一个空格
// Wrong
if(foo){
}
// Correct
if (foo) {
}
- 对指针和引用,在类型和*、&之间加一个空格,但在*、&与变量之间不加空格
char x;
const QString &myString;
const char const y = "hello";
- 二元操作符前后加空白
- 类型转换后不加空白
- 尽量避免C风格的类型转换
// Wrong
char* blockOfMemory = (char* ) malloc(data.size());
// Correct
char blockOfMemory = reinterpret_cast<char>(malloc(data.size()));
大括号
- 基本原则:左大括号和语句保持在同一行:
// Wrong
if (codec)
{
}
// Correct
if (codec) {
}
- 例外:函数定义和类定义中,左大括号总是单独占一行:
static void foo(int g)
{
qDebug("foo: %i", g);
}
class Moo
{
};
- 控制语句的body中只有一行时不使用大括号
// Wrong
if (address.isEmpty()) {
return false;
}
for (int i = 0; i < 10; +i) {
qDebug("%i", i);
}
// Correct
if (address.isEmpty())
return false;
for (int i = 0; i < 10;i)
qDebug("%i", i);
- 例外1:如果父语句跨多行,则使用大括号
// Correct
if (address.isEmpty() || !isValid()
!codec) {
return false; }
圆括号
Switch 语句
断行
继承与关键字 `virtual`
通用例外
|