codestyle.md

Содержание

Стандарт кодирования

• Общие требования
  • Именование переменных
  • Форматирование текста программы
  • Написание комментария

Стандарт кодирования

1 Общие требования

1.1 Именование переменных

1. Имена переменных составляются из слов английского языка (транслитерация русских слов не допускается).
2. Имена неконстантных переменных, объектов состоят из строчных символов. Начало имени начинается со строчной буквы. Слова не разделяются символом подчеркивания «_», вместо этого каждое следующее слово начинается с заглавной буквы. Пример: isVariable.
3. Имена классов, методов, структур состоят из строчных символов. Начало имени начинается с заглавной буквы. Слова не разделяются символом подчеркивания «_», вместо этого каждое следующее слово начинается с заглавной буквы. Пример: MyClass, MyMethod(). Более подробно - тут

1.2 Форматирование текста программы

1. Длина строки равна 80 символам. Если строка программного кода не помещается целиком, она разбивается на несколько строк
2. Абзацный отступ – 4 пробела.
3. В строке располагается только один оператор.
4. Фигурная скобка в системных выражениях располагается согласно стандартным настройкам редактора C#. Пример:

SystemWord (…)
{
    // Какой-то код.
}

5. Используются фигурные скобки, даже если в условном операторе имеется одна строка. Пример:

if(Something())
{
    SomethigElse();
}

1.3 Написание комментария

1. Комментарии должны быть предложениями на русском языке, они должны быть хорошо составлены и иметь правильную пунктуацию, по возможности без сокращений.
2. Комментирование объявления класса (структуры) может осуществляться в следующем виде:

//------------------------------------------------------------------------------
/// <summary> Убрать определенный элемент из коллекции
/// </summary>
class StepPath
{
};

3. Комментирование определения функций осуществляется в следующем виде:

//------------------------------------------------------------------------------
void DescriptiveName(type descriptiveName)
{
    // Здесь помещается комментарий, описывающий, как
    // функция делает то, что она делает. Он может пропускаться
    // если программа сама по себе достаточно содержательна.
    CodeGoesHere();
}

4. Комментирование объявления методов (функций) осуществляется в следующем виде:

/// <summary> Removes the specified item from the collection
/// </summary>
/// <param name="newCloseDevCnt">The item to remove
/// </param>
/// <param name="newOpenDevCnt">The group containing the item
/// </param>
/// <remarks>
/// If parameter "NewOpenDevCnt" is null, an exception is raised.
/// <see cref="EArgumentNilException"/>
/// </remarks>
/// <returns>True if the specified item is successfully removed;
/// otherwise False is returned.
/// </returns>
int SetDevCnt(uint2 newCloseDevCnt,
    uint2 newOpenDevCnt);

5. Должно использоваться форматирование кода согласно стандартных настроек Microsoft Visual Studio для C#. Пример:

int x;  // Описание что делает x.
unsigned long int (*pfi)(); // Описание что делает pfi.
int z;  // Описание что делает z.
const char *theVariable;    // Описание the_variable.
x = 10; // Здесь идет комментарий.
theVariable = x;    // Здесь второй комментарий.
z = x;  // A здесь третий.