Skip to content

Latest commit

 

History

History
108 lines (76 loc) · 7.43 KB

commentrules.md

File metadata and controls

108 lines (76 loc) · 7.43 KB

< Содержание

Правила комментирования

Шаблон комментария в модулях

// Градум; <ФамилияИсполнителя> (<?"", ДатаВремя, "ДФ='dd.mm.yyyy'">)); №.<НомерЗадачиЕРП> <НазваниеЗадачиЕРП> №<НомерЗадачиВнеш>

> НомерЗадачиЕРП - Номер задачи из AxelotERP.
> НазваниеЗадачиЕРП - Название задачи из AxelotERP.
> НомерЗадачиВнеш - Номер задачи из трекера заказчика. Указывается в задаче на разработку.

При изменении блоков кода необходимо указывать начало и окончание вносимых изменений. При этом, комментарий блока кода в начале должен начинаться с //+++, а комментарий в конце с //---}.

  • // +++Градум; <ФамилияИсполнителя> (<?"", ДатаВремя, "ДФ='dd.mm.yyyy'">)); №.<НомерЗадачиЕРП> <НазваниеЗадачиЕРП> №<НомерЗадачиВнеш>
  • // ---Градум; <ФамилияИсполнителя> (<?"", ДатаВремя, "ДФ='dd.mm.yyyy'">)); №.<НомерЗадачиЕРП> <НазваниеЗадачиЕРП> №<НомерЗадачиВнеш>

после символа "// " необходим пробел, инче автоматизированные системы проверки кода будут указывать на ошибку.

Пример комментария:

// +++ Градум; Смирнов; 25.01.2021; №0000176234 №ITMNK-00380 

// Измененный/Добавленный код

// --- Градум; Смирнов; 25.01.2021; №0000176234 №ITMNK-00380

Правила комментирования в модулях

  • Если выполняется изменение кода типовой конфигурации, то удаляемый код должен быть закомментирован. Если доработки выполняются в нетиповых объектах, неиспользуемый код удаляется.
    Пример доработки типового модуля:
//Код до модификации

ПеременнаяТиповогоКода = Значение1;
ПроцедураТиповогоКода( Значение1, Значение2 );

//Код после модификации:

ПеременнаяТиповогоКода = Значение1;

// +++ Градум; Смирнов; 20.12.17; №0000176234 №ITMNK-00382
НоваяПеременная = грПреобразоватьЗначение(Значение1);

//ПроцедураТиповогоКода( Значение1, Значение2 );
ПроцедураТиповогоКода( НоваяПеременная, Значение2 );

…..
// --- Градум; Смирнов; 20.12.17; №0000176234 №ITMNK-00382
  • Если добавляется новая процедура/функция в существующий модуль, то комментарии к ней необходимо писать в начале процедуры (для каждой процедуры, если их несколько). Ниже строки КонецПроцедуры никаких комментариев не писать! То же самое касается объявления общих переменных в начале модуля. Это необходимо для правильного сравнения-объединения модулей.
// +++ Градум; Смирнов; 20.12.17; №0000176234 №ITMNK-00382
// Заголовок процедуры
Процедура  НоваяПроцедура()
    ...
КонецПроцедуры // ниже этой строки ничего не писать!

Шаблон комментария при помещении в хранилище

Измененные объекты помещаются в хранилище в рамках одной задачи. Не допускается помещать в хранилище изменения выполненные по разным задачам.

Шаблон комментария:

НомерЗадачиЕРП 
НомерЗадачиВнеш 
Описание задачи:

НомерЗадачиЕРП - Номер задачи из AxelotERP.

НомерЗадачиВнеш - Номер задачи из трекера заказчика. Указывается в задаче на разработку.

Описание задачи - краткое описание задачи из трекера.

Пример:

0000176234
ITMNK-00382
Описание задачи: В справочник "ДоговорыКонтрагентов" добавить реквизит "грСлужебный" Тип....

Общие правила комментирования

  • Простой код необходимо писать и структурировать так, чтобы никаких дополнительных пояснений к нему не требовалось.
  • Комментарии, которые не поясняют, а пересказывают код, недопустимы.
  • Сложный код необходимо сопровождать сжатыми и четкими пояснениями.
  • Длинные линейные фрагменты кода при помощи комментариев необходимо разбивать на фрагменты.
  • Если код требует комментария для пояснения работы - в первую очередь необходимо рассмотреть варианты рефакторинга, чтобы код не требовал комментария.
  • Длина строки комментария не должна превышать 120 символов.
  • Заголовки процедур и функций (за исключением предопределенных) являются строго обязательными.