QGen 5 - стандарты кодирования

Nex Moderator • 25.03.2013 17:01 • 20 comments • 19819 views

Для совместной разработки важно установить стандарты кодирования.

Обсуждать будем в этой теме. Здесь же будет текущая версия стандартов.

В качестве отправной точки был взят http://qt-project.org/wiki/Qt_Coding_Style (на русский перевод не смотреть, там неадекват)

Нынешняя версия стандартов:

1. Выравнивание.

1.1 Выравнивание должно быть в 4 пробела.

1.2 Не использовать табуляцию, использовать пробелы.

2. Пробелы.

2.1 В конце строки не должно быть пробелов. Соответственно пустые строки не должны содержать пробелы.

2.2 Указатели и ссылки отделяем от типа одним пробелом и не отделяем от имени переменной.

// Правильно
        char *x;
        const QString &myString;
        // Неправильно
        char* y;
        const QString& yourString;
        char * z;
        const QString & theirString;

2.3 Операторы *, /, +, -, %, =, ||, &&, ==, !=, |, & выделяются пробелами.

// Правильно
        d = (a * b) + c;
        if (doLocationExists && !exit)
        // Неправильно
        d = (a*b) + c;
        if (doLocationExists&&!exit)

2.4 После открывающей круглой скобки и перед закрывающей круглой скобкой пробел не ставится.

// Правильно
        d = (a * b) + c;
        if (doLocationExists && !exit)
        // Неправильно
        d = ( a * b ) + c;
        if ( doLocationExists && !exit )

2.5 После каста пробел не ставится.

// Правильно
        d = (int)c;
        // Неправильно
        d = (int) c;

3. Именование.

3.1 Имена переменных и методов пишутся в такомРегистре.

3.2 Имена классов пишутся в ТакомРегистре. Если класс производный от QObject,
то в начало имени добавляется “Q”: QMyNewDialog.

3.3 Аббревиатуры пишутся так: myQspSyntaxRules.

4. В релизе не должно быть непереведённых строк.

Edited at 28.03.2013 18:03 (13 years ago)

Byte Admin 26.03.2013 15:51 (13 years ago)

Nex Moderator 26.03.2013 20:41 (13 years ago)

rrock.ru #27 26.03.2013 23:00 (13 years ago)

Nex Moderator 27.03.2013 04:37 (13 years ago)

Nex Moderator 27.03.2013 05:30 (13 years ago)

Byte Admin 27.03.2013 07:08 (13 years ago)

Byte Admin 27.03.2013 07:20 (13 years ago)

Nex Moderator 27.03.2013 07:47 (13 years ago)

rrock.ru #27 27.03.2013 09:09 (13 years ago)

Byte Admin 28.03.2013 16:16 (13 years ago)

Nex Moderator 28.03.2013 18:01 (13 years ago)

rrock.ru #27 29.03.2013 10:13 (13 years ago)

Nex Moderator 29.03.2013 16:04 (13 years ago)

rrock.ru #27 29.03.2013 18:14 (13 years ago)

Кстати, еще хотелось бы уточнить, если действие в условии одно, то заключаем ли его в скобки?

// 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);

Byte Admin 29.03.2013 19:13 (13 years ago)

Повторю:

Предлагаю за основу взять всё же статью с Хабра: http://habrahabr.ru/post/172091/ (там более или менее адекватные правила на мой взгляд).
И договориться об оговорках. Например, я предпочитаю отделять символы ссылок и указателей с 2х сторон пробелами:
char * ptr;
const PString & str;
int *** array;
Это касается всех объявлений, в т.ч. для параметров функций/методов.

Кроме этого, суффиксы/префиксы для членов класса я предпочитаю использовать в т.ч. для protected полей, а не только для private.

Для префиксов можно использовать либо “m_”, либо подчеркивание:
int m_count; // так
int _count; // или так
Разумеется, использовать нужно будет что-то одно.
Такие префиксы используются только для private и protected полей. Для public полей (они могут быть использованы, к примеру, в структурах) префиксы использовать не следует.
В классах public полей следует избегать, предпочитая для доступа к полям методы.

Комментарии предпочтительно писать на английском, да и в целом - русский текст только в файлах локализаций.
Про “*” и “&” есть аргументы:
кто-то предпочитает указывать их сразу перед именем переменной, кто-то сразу после типа:
Вариант 1: int **array; // часто используется именно такая запись, однако для ссылок - часто используется вариант 2
Вариант 2: int** array;

И у того, и у другого варианта есть свои сторонники.
Из этих двух вариантов я за вариант 2, так как указание “ссылка”/”указатель” является скорее частью типа переменной, чем частью имени.
Однако, такая запись для многих непривычна.
Самым разумным вариантом является вариант 3:
int ** array;
Здесь лучше (из всех вариантов) видно признак указателя, и это (наглядность) важный момент.
К тому же, такая запись ясно указывает на особенный статус указателей и ссылок.

Если при указании типа нужно комбинировать ссылки / указатели, то между группами символов ставится пробел. Например:
int ** & array; // ссылка на указатель на указатель