Именование

• Файлы: все исходные файлы кода используют имена в нижнем регистре, и имя файла соответствует имени класса в файле.

• Классы: начинаются с заглавной буквы, следуют соглашению об именовании CamelCase, используют английские существительные для сокращения слов, не более трёх последовательных заглавных букв.

• Методы классов: начинаются со строчной буквы, следуют CamelCase.

• Члены классов: начинаются с «m_», за которым следует слово со строчной буквой, следуют CamelCase.

• Атрибуты: получают имена, соответствующие именам членов (без «m_»), установка атрибутов начинается с «set» и использует заглавные буквы.

• Локальные переменные: начинаются со строчных букв, следуют CamelCase.

• Перечисления: члены перечислений начинаются с аббревиатуры типа перечисления, за которой следует символ подчёркивания («_»). Например, CmdPort в перечислении OptionType будет называться Opt_CmdPort.

Комментарии

Комментарии включают блочные комментарии /* */ и однострочные комментарии //.

• Комментарии к классам: пример:

/**
 * Класс CommandParser
 * анализирует параметры команды.
 */

• Комментарии к методам: обычно все методы должны быть прокомментированы, но это не обязательно для перегруженных методов. Пример:

/**
* cmdIPTuple получает IP-пятиэлементный кортеж команды.
* @param dest выходной параметр.
* @return возвращает true при успешном выполнении.
*/

• Комментарии к членам: пример:

    int m_sampling;   // частота выборки данных
    int m_allowErrorCode;    // допустимый размер ошибки пакета данных
    QTime m_startTime;  // время запуска
    qint64 m_totalSampleCount; // общий объём полученных данных

Формат кода

Формат кода включает использование if и while.

• Условные операторы if:

if(condition)
{
  dosth..
}

• Циклы while:

while(condition)
{
dosth...
}

или

do{
 dosth...
}while(condtion)

Кодировка файлов

Все файлы кода сохраняются в формате UTF-8 с BOM.

Другие стандарты

• Количество строк кода в классе ограничено 500 строками.
• Количество строк кода метода класса ограничено 50 строками.
• Глубина наследования классов не должна превышать 3 уровней.
• Вложенность операторов while, if-else, switch-case и т. д. не должна превышать 3 уровня.