1С 8.3 Комментарии при редактировании кода
Данные > Примеры кода 1С > 1С 8.3 Процедуры и Функции
Перейти в раздел примеры кода 1С 8.3:
Любые изменения кода в модулях должны сопровождаться комментариями. Такие уточнения имеют специальный формат.
//++ Artur K. 09.09.2024 000254 Изменёна формула пересчета.
// Было: Сумма = ?(ФактЧасов=0, 0, ОтработанныеЧасы/ФактЧасов * Параметр);
Сумма = ?(ПланЧасов=0, 0, ОтработанныеЧасы/ПланЧасов * Параметр);
//-- Artur K. 09.09.2024
// Было: Сумма = ?(ФактЧасов=0, 0, ОтработанныеЧасы/ФактЧасов * Параметр);
Сумма = ?(ПланЧасов=0, 0, ОтработанныеЧасы/ПланЧасов * Параметр);
//-- Artur K. 09.09.2024
Обозначения:
//++ — начало комментария
//-- — конец комментария
Artur K. — имя программиста
000254 — номер задачи в трекере. Ставим только в открывающемся комментарии.
Доработка на старте – текст комментария. Применяется, если номер задачи есть. Если его нет, текст пишем обязательно.
Комментарии по стандартам 1С-разработки используют для выделения модификаций. Если код изменен повторно через некоторое время, текст не пишем. Но когда модификация редактируется уже другим разработчиком в другой задаче, комментировать обязательно.
Горячие клавиши:
- добавить комментарий в выделенных строках: ctrl + /
- удалить комментарий в выделенных строках: ctrl + shift + /
В данном случае комментарий не удаляется, а удаляется символы комментирования из каждой строк выделенного блока.
Комментарии кода служат для:
- описания сложных участков кода или алгоритма
- логического отделения блоков непрерывного кода, в данном случае поле «\\» ничего не пишется
- описания функций и процедур
- выделения изменений в код типовых конфигураций, при обновлении упростит разбор
- описания ситуации внесения изменений, даты
- отметка ошибочного или сомнительного кода, в процессе code review (анализа качества кода 1С).
Шаблон 1С 8.3:
//{MyLogin ("НомерЗадачи", ВыборВарианта, "ОтработанноеВремя", "000254", "Доработкая для кадровика", "00","Без номера", "">) "", ДатаВремя, "ДФ=yyyy.MM.dd">>
Стиль jsDoc. Пример в 1С 8.3:
//**
//* Это супер функция, которая делает, что-то
//* важное.
//*
//* @param {Число} Параметр1
//* @param {СправочникСсылка.Контрагенты} Контрагент
//* @return {Массив.}
Функция МояСуперФункция(Параметр1, Контрагент)
//TODO написать код функции
КонецФункции
//* Это супер функция, которая делает, что-то
//* важное.
//*
//* @param {Число} Параметр1
//* @param {СправочникСсылка.Контрагенты} Контрагент
//* @return {Массив.}
Функция МояСуперФункция(Параметр1, Контрагент)
//TODO написать код функции
КонецФункции
0
комментарии
____________________
Перепечатка текста и фотографий разрешена при наличии прямой ссылки на источник