Qt--编码规范

Love The Way You Lie 2023-01-04 13:27 78阅读 0赞

### Qt--编码规范 ###

*  1、缩进
 *  2、声明变量
 *  3、空白行和空格
 *  4、花括号
 *  5、圆括号
 *  6、Switch 语句
 *  7、跳转语句
 *  8、换行

# 1、缩进 #

> 在Qt中，缩进是4个空格。不要用tab键缩进。

# 2、声明变量 #

> 1）、一个变量占一行

//正确
    int width;
    int height; 
    
    int width,height; //错误

> 2）、不要使用过于简短或者无意义的变量名，变量名最好是见名知意。

int x;	//变量名过于简短
    int sdfg; //变量名无意义
    
    //正确
    int height;
    int width;

> 3）、单字符变量名称仅适用于计数器和临时变量。变量在需要的地方进行声明。

> 4）、变量名和函数名以小写字母开头，当变量名或函数名由多个单词组成时，从第二个单词开始每个单词的首字母大写，其余字母均小写。

//正确
    int maxValue;
    int getArea();
    int setMaxValue();

> 5）、类名首字母始终为大写字母。公共类在类名前加上“Q”，公共函数名前加“q”

class DateTime //普通类
    { 
    	void getTime(); //普通函数
    }
    
    class QDateTime //公共类
    { 
    	void qGetTime(); //公共函数
    }

> 6）、避免缩写；变量名不要全部大写；变量名由多个单词组成时不要用"\_"符号连接。

//错误
    int Cntr; 
    int DATE_TIME; 
    
    //正确
    int counter;
    int dateTime;

# 3、空白行和空格 #

> 1）、利用空行将语句恰当的分组（按照逻辑分组），始终只使用一个空行（不要空多行）

//错误
    int width = this->width();
    int height = this->height();
    int side = qMin(width, height);
    QPainter painter(this);
    ...
    
    //错误
    int width = this->width();
    int height = this->height();
    int side = qMin(width, height);
    
    
    
    QPainter painter(this);
    ...
    
    //Correct
    int width = this->width();
    int height = this->height();
    int side = qMin(width, height);
    
    QPainter painter(this);
    ...

> 2）、在关键字和花括号之间使用一个空格

// Wrong
     if(foo){ 
     }
    
     // Correct
     if (foo) { 
     }

> 3）、对于指针或引用，始终在类型和&、\*之间使用单个空格，但在&、\*与变量名称之间请勿使用空格

char *x;
    const QString &myString;
    const char * const y = "hello";

> 4）、二元运算符（+、-、\*、/等）的左右都需要加一个空格

//Wrong
    int sum = a+b;
    
    //Correct
    int sum = a + b;

> 5）、逗号后面加一个空格（逗号前面无空格）

int main(int argc, char *argv[])
    { 
    	//TODO
    }

> 6）、类型转换运算符后面不加空格（尽量避免使用C语言中的类型转换）

// Wrong
     char* blockOfMemory = (char* ) malloc(data.size());
     char *blockOfMemory = reinterpret_cast<char *> (malloc(data.size()));
    
     // Correct
     char *blockOfMemory = reinterpret_cast<char *>(malloc(data.size()));

> 7）、一条语句只占一行

> 8）、控制流语句的主体应另起一行

// Wrong
     if (foo) bar();
    
     // Correct
     if (foo)
         bar();

# 4、花括号 #

> 1）、左括号和语句的开头在同一行（函数和类除外），如果右括号后面有关键字，则该关键字与右括号在同一行。

// Wrong
     if (codec)
     { 
     }
     else
     { 
     }
    
     // Correct
     if (codec) { 
     } else { 
     }

> 2）、在函数的实现和类的声明中，左括号总是在一行的开头，右括号单独占一行。

void sum(int a, int b)
    { 
    	//TODO
    }
    
    class Rect
    { 
    	//TODO
    };

> 3）、当条件语句的主体语句多于一句时使用花括号。  
> 当然也有两种特殊情况：  
> 第一、如果父语句占有多行，或经过多层封装，子语句要用花括号括起来。  
> 第二、在if-else语句块中，如果if或else中的一个包含了多行，另一个为了对称性原则，也要用花括号

// Wrong
     if (address.isEmpty()) { 
         return false;
     }
    
     for (int i = 0; i < 10; ++i) { 
         qDebug("%i", i);
     }
    
     // Correct
     if (address.isEmpty())
         return false;
    
    if (address.isEmpty()) { 
    	qDebug << "Error!";
    	return false;
    }
    
     for (int i = 0; i < 10; ++i)
         qDebug("%i", i);
    
     // Correct，父语句占多行
     if (address.isEmpty() || !isValid()
         || !codec) { 
         return false;
     }
     
    
    /****************** if-else语句 *********************/
    // Wrong
     if (address.isEmpty())
         qDebug("empty!");
     else { 
         qDebug("%s", qPrintable(address));
         it;
     }
    
     // Correct
     if (address.isEmpty()) { 
         qDebug("empty!");
     } else { 
         qDebug("%s", qPrintable(address));
         it;
     }
    
     // Wrong
     if (a)
         …
     else
         if (b)
             …
    
     // Correct
     if (a) { 
         …
     } else { 
         if (b)
             …
     }

> 4）、当条件语句的执行体是空语句的时候，用一个花括号

// Wrong
     while (a);
    
     // Correct
     while (a) { }

# 5、圆括号 #

> 用圆括号将语句恰当分组

// Wrong
     if (a && b || c)
    
     // Correct
     if ((a && b) || c)
    
     // Wrong
     a + b & c
    
     // Correct
     (a + b) & c

# 6、Switch 语句 #

> case标签和switch在同一列；  
> 每一个case语句的末尾都要有一个break语句或return语句，除非因功能需要故意不加或另外一个case是紧跟上一个case的。

switch (myEnum) { 
    case Value1:
      doSomething();
      break;
    case Value2:
    case Value3:
      doSomethingElse();
      Q_FALLTHROUGH();
    default:
      defaultHandling();
      break;
    }

# 7、跳转语句 #

> 不要在跳转关键词（包括：break, continue, return, goto）后边加else。但如果这段代码是固有的对称结构，用else实现视觉上的对称也是可以的。

// Wrong
     if (thisOrThat)
         return;
     else
         somethingElse();
    
     // Correct
     if (thisOrThat)
         return;
     somethingElse();

# 8、换行 #

> 1)、当一行字符个数多余100个（包含100）时应当换行。

> 2)、换行时逗号在行尾。

Widget::Widget(QWidget *parent) :
        QWidget(parent),
        ui(new Ui::Widget)
    { 
    	//TODO
    }

> 3)、若在运算符处换行，则运算符在新行的开头位置（因为编辑器过窄的话，操作符在行尾容易看不见）

// Wrong
     if (longExpression +
         otherLongExpression +
         otherOtherLongExpression) { 
     }
    
     // Correct
     if (longExpression
         + otherLongExpression
         + otherOtherLongExpression) { 
     }