1с комментарии кода 1С : Предприятия— это внесение пояснений в тест модулей, которые не является обязательными и не влияют на алгоритм (не исполняются)
Производится с помощью последовательности «//«, при этом комментарием считается все, что находится после.
Горячие клавиши
ctrl + / — добавить комментарий в выделенных строках;
ctrl + shift + / — удалить комментарий в выделенных строках
В данном случае комментарий, конечно, не удаляется, а удаляется символы комментирования из каждой строк выделенного блока.
Установка и снятие комментария интерактивно:
Выделяется код и нажимаются на панели «Модуль» соответствующие кнопки «Добавить комментарий» и снять «Комментарий»
Меню «Текст\Блок\Добавить комментарий» или «Текст\Блок\Удалить комментарий»
комментарии 1с кода служат для:
- описания сложных участков кода или алгоритма
- логического отделения блоков непрерывного кода, в данном случае поле «\\» ничего не пишется
- описания функций и процедур
- выделения изменений в код типовых конфигураций, при обновлении упростит разбор
- описания ситуации внесения изменений, даты
- отметка ошибочного или сомнительного кода, в процессе code review (анализа качества кода 1С).
Правила комментирования кода действуют и для языка запросов 1С, но важно отметить, что при использовании Конструктора запроса(визуального средства разработки запроса к базе), комментарии удаляются полностью, а не снимается признак «\\».
Среда разработки может автоматически сворачивать комментарии, для удобства восприятия
Настроить это можно в меню «Сервис\Параметры» далее вкладки «Модули\Группировка»
Там же на вкладке «Модули\Редактирование» возможно отключить или поменять цвет выделения комментария с зеленого (по умолчанию).
Комментарии при групповой разработке
Любые изменения кода в модулях должны сопровождаться комментариями. Такие уточнения имеют специальный формат.
//++ ГВА 01.11.2024 000254 Расчет себестоимости с учетом проблемы копеек.
// Было: Сумма = ?(КоличествоОстаток=0, 0, СуммаОстаток/КоличествоОстаток * Количество);
Сумма = ?(КоличествоОстаток=0, 0, Количество/КоличествоОстаток * СуммаОстаток);
//-- ГВА. 01.11.2024Обозначения:
//++ — начало комментария
//– — конец комментария
ГВА— Фамилия имя отчество программиста
000254 — номер задачи . Ставиться только в открывающемся комментарии.
Доработка на старте – текст комментария. Применяется, если номер задачи есть. Если его нет, текст пишем обязательно.
Комментарии по стандартам 1С-разработки используют для выделения модификаций. Если код изменен повторно через некоторое время, текст не пишем. Но когда модификация редактируется уже другим разработчиком в другой задаче, комментировать обязательно.