Coding Style

Стиль именования переменных построен на базе стиля Qt

Именование файлов

Имена фалов указываются в lower_snake_case.

Пространство имен

UpperCamleCase

// Неправильно
namespace upper_camle_case {

}

// Правильно
namespace UpperCamleCase {

}

Именование классов

UpperCamleCase

// Неправильно
class upper_camle_case {

}

// Правильно
class UpperCamleCase {

}

Именование в перечислениях (enum)

Имя enum и значение перечислителя в UpperCamleCase

// Неправильно
enum class upper_camle_case: size_t {
   value_upper_camle_case
}

// Правильно
enum class UpperCamleCase: size_t {
   MY_VALUE
}

Объявление переменных

Объявляйте по одной переменной в строке.

Избегайте, если это возможно, коротких и запутанных названий переменных (Например: “a”, “rbarr”, “nughdeget”).

Односимвольные имена переменных подходят только для итераторов циклов, небольшого локального контекста и временных переменных. В остальных случаях имя переменной должно отражать ее назначение.

Заводите переменные только по мере необходимости.

// Неправильно
int a, b;
char *c, *d;

// Правильно
int height;
int width;
char m_nameOfThis;
char m_nameOfThat;
char m_name_that;
char m_name_this;

Избегайте аббревиатур

// Неправильно
short Cntr;
char ITEM_DELIM = ' ';

// Правильно
short counter;
char itemDelimiter = ' ';

Именование функций

lowerCamleCase

Избегайте аббревиатур

// Неправильно
short Cntr();
char ITEM_DELIM();

// Правильно
short counter();
char itemDelimiter();
short row_counter();
char item_delimiter();

Пример использования using

using SWidget = std::shared_ptr<QWidget>();

SWidget t;

void fun (SWidget t)