CodeStyle

Именование

  • Все имена кроме констант пишутся слитно
  • Каждое слово в именах начинается с заглавной буквы
  • Константы пишуться большими буквами
  • Каждое слово в константах разделяются подчеркиванием
class ИмяКласса
{
    void ИмяМетода();

    int имяПеременной;

    const int ИМЯ_КОНСТАНТЫ;
}

Комментарии

  • До комментария необходимо отступать две пустые строки
  • После комментария до кода ставится пустая строка с символами однострочного комментария
код
 
 
// Комментарий
//
код
  • Многострочные комментарии имеют на каждой строке символ *
  • Звездочки выровнены в один столбик по самой верхней в этом блоке
  • Перед комментарием до кода необходимо оставлять две пустые строки
  • После текста комментария ставится символ конца многострочного комментария выровненный по звездочке
код
 
 
/* Многострочный 
 * комментарий
 */
код
  • Комментарий разделяющий длинный код на смысловые блоки
  • Перед и после строки с комментарий оставляются по три пустые строки
длинный код
 
 
//=== Комментарий ===
 
 
длинный код

Переменные

  • Объявление переменных начинать с новой строки
  • Перед каждой переменной указывать тип к которому она принадлежит
// Правильно
//
int a;
int c;
 
// НЕправильно
//
int a,
    c;
 
// НЕправильно
//
int a, c;
  • Объявлять константные переменные с помощью const, а не #define
// Правильно
//
const int PI = 3.14;
const QString DATABASE_NAME = "GpsDataDB";
 
// НЕправильно
//
#define PI = 3.14
#define DATABASE_NAME = "GpsDataDB"

Методы

  • Каждый метод от предыдущего отделяют 5 пустых строк
метод1
{
...
}
 
 
 
 
 
метод2
{
...
}
 
 
 
 
 
метод3
{
...
}
  • Вызов метода может вызываться параметрами в одну или несколько строк
  • Если параметры переносятся, то во всех строках кроме первой должен быть только один параметр
  • Когда каждый параметр записан в новой строке, завершающая скобка должна находится на новой строка и выравниваться по открывающей
// Правильно
//
вызовМетода(пар1, пар2, пар3, пар4);
 
 
// Правильно
//
вызовМетода(пар1, пар2, пар3, 
            пар4);
 
// Правильно
//
вызовМетода(пар1, пар2, 
            пар3,
            пар4);
 
 
// Правильно
//
вызовМетода(
            пар1, 
            пар2, 
            пар3, 
            пар4
           );
 
 
// НЕправильно
//
вызовМетода(пар1, 
            пар2, 
            пар3, 
            пар4
           );
 
 
// НЕправильно
//
вызовМетода(пар1, пар2, 
            пар3, пар4
           );

Внешние ссылки

Добавить комментарий

Ваш e-mail не будет опубликован. Обязательные поля помечены *

*