К статье
Практический материал

Другое · 7 мин

Комментирование в 1С: код, объекты и проверка

Как ставить комментарии в коде 1С: однострочные и блочные, описания объектов конфигурации, проверка результата и частые ошибки при разработке.

В 1С:Предприятии комментарии нужны для объяснения логики процедур, функций, модулей объектов и отладочного кода. Они не выполняются платформой, но хранятся в исходниках конфигурации и видны разработчику при открытии вКонфигураторе.

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

Комментарии не заменяют внешнюю документацию и не защищают конфиденциальную логику. Любой пользователь с доступом к конфигурации может просмотреть исходный код, поэтому в комментариях не следует хранить пароли, ключи, персональные данные или коммерческую тайну.

Где и зачем используются комментарии в 1С

В текстовых модулях — общих, форм, объектов, менеджеров — комментарии поясняют алгоритм, условия ветвления, причину выбора того или иного варианта и временно отключённый код. Это помогает при возврате к модулю через неделю или месяц, а также при коллективной разработке.

В конфигурации комментарии и описания добавляют справочникам, документам, регистрам, планам обмена и их реквизитам. Такие тексты могут отображаться в интерфейсе или использоваться только вКонфигураторе, в зависимости от свойства и настроек локализации.

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

Синтаксис комментариев встроенного языка

Однострочные комментарии

Символ // помечает всё, что следует за ним до конца строки, как комментарий. Платформа игнорирует этот текст при выполнении. Можно ставить // в начале строки или после кода на той же строке.

1c
// Комментарий до конца строки
Процедура Пример()
    Сообщить("Работает"); // краткое пояснение
КонецПроцедуры

Блочные комментарии

Символы / открывают блочный комментарий, а / закрывают его. Всё между этими маркерами игнорируется, в том числе несколько строк. Удобно для отключения больших фрагментов или подробного описания сложного алгоритма.

Не вкладывайте блочные комментарии внутрь других блочных без проверки поведения используемой конфигурации, и не оставляйте незакрытый символ */ — это приведёт к ошибке синтаксиса и не даст сохранить модуль.

Временное отключение кода

Для отладки фрагмент можно закомментировать, запустить проверку, затем раскомментировать или удалить. Оставлять большой объём «мёртвого» кода в финальной версии не рекомендуется: он усложняет чтение и может ввести в заблуждение при поддержке.

Комментарии объектов конфигурации

Свойства объектов и реквизитов

ВКонфигураторе у большинства объектов есть поля «Комментарий», «Описание», «Синоним» или аналогичные, в зависимости от типа метаобъекта. Заполняйте их для справочников, документов, регистров, планов видов характеристик и их реквизитов.

Описание реквизита часто видно пользователю в форме или при выборе, поэтому формулируйте его нейтрально и без технических подробностей, не предназначенных для конечного пользователя. Технические примечания лучше оставить в комментарии модуля или в отдельной документации.

Порядок действий при комментировании модуля
  1. 1
    Определите фрагмент, который требует пояснения или отключения
  2. 2
    Выберите // для одной строки или /<em> ... </em>/ для блока
  3. 3
    Проверьте синтаксис и сохраните модуль
  4. 4
    Убедитесь, что конфигурация запускается и работает корректно

Отличие от комментариев кода

Описание объекта конфигурации относится к метаданным, а не к исполняемому тексту. Оно не влияет на алгоритм работы, но может использоваться при генерации форм, отчетах или обработках, если разработчик явно обращается к свойствам объекта.

Как комментировать процедуры и параметры

Заголовки процедур и функций

Перед объявлением процедуры или функции полезно указать, что она делает, при каких условиях вызывается и что возвращает. Если процедура экспортируемая, укажите, какие модули могут использовать её и какие ограничения существуют при вызове на сервере.

Контрольные точки

Как проверить результат комментирования

Модуль сохраняется без ошибок синтаксиса
Норма

Платформа принимает код и открывает конфигурацию

Тревожный признак

Появляется сообщение об ожидаемом символе или незакрытом комментарии

Приложение запускается и выполняет алгоритм
Норма

Результат работы совпадает с ожидаемым

Тревожный признак

Код не выполняется или работает иначе после комментирования

Параметры и переменные

Короткие комментарии рядом с параметрами помогают понять допустимые типы, значения по умолчанию и порядок обязательности. Для локальных переменных поясняйте назначение только если имя переменной не делает это самоочевидным.

Проверка и поддержка комментариев

Поиск и навигация

Используйте поиск по модулям и конфигурации, чтобы находить комментарии по ключевым словам: «TODO», «ОТЛАДКА», «ИСПРАВИТЬ», имена авторов или номера задач. Это упрощает поиск мест, требующих доработки после релиза.

Сравнение и обновление конфигураций

При сравнении версий конфигурации изменения в комментариях могут отображаться как правки кода, даже если логика не менялась. Перед переносом между базами проверьте, не появились ли конфликты в закомментированных фрагментах, и удалите неактуальный отладочный текст.

Ограничения и риски

Комментарии не являются средством защиты информации. Любой пользователь с правами на редактирование или просмотр конфигурации может прочитать их, поэтому не записывайте в комментарии пароли, токены, персональные данные клиентов или коммерческую тайну.

Типичные ошибки
01
Оставлять незакрытый блок /<em> без </em>/ — модуль не сохраняется и выдаёт ошибку синтаксиса
02
Хранить пароли и секреты в комментариях — они доступны всем, у кого есть конфигурация
03
Оставлять большой объём отладочного кода в финальной версии — усложняет поддержку и вводит в заблуждение

Избыточное комментирование ухудшает читаемость так же, как его отсутствие. Не поясняйте очевидное, не дублируйте имена переменных и не оставляйте огромные блоки кода, который больше не используется. Если фрагмент точно не понадобится, лучше удалить его, чем закомментировать «на всякий случай».

Частые ошибки и как их исправить

Если обнаружили незакрытый комментарий, найдите пару символов / и /, восстановите баланс или удалите лишний фрагмент, затем сохраните модуль. Если пароль попал в комментарий, удалите текст, смените скомпрометированные учётные данные и проверьте историю изменений, если она ведётся.

Итог

Что важно запомнить

Комментарии в 1С не влияют на выполнение, но облегчают поддержку; используйте // и /<em> </em>/ в коде, заполняйте описания объектов конфигурации, не храните секреты и удаляйте неактуальный отладочный код.

Можно ли вложить один блочный комментарий в другой?

Обычно вложенные блочные комментарии небезопасны и могут вызвать ошибку синтаксиса в зависимости от конфигурации и режима работы. Лучше использовать однострочные // для внутренних пояснений или удалять лишний фрагмент полностью.

Отображаются ли комментарии кода пользователям в приложении?

Комментарии в текстовых модулях предназначены для разработчиков и не выводятся обычным пользователям в рабочем интерфейсе. Однако описания реквизитов и объектов конфигурации могут попасть в формы, отчёты или справочную информацию, если так настроено решение.

Нужно ли комментировать каждую строку кода?

Нет. Комментируйте неочевидную логику, условия, причины принятия решений и назначение параметров. Очевидные действия, такие как присвоение значения переменной с понятным именем, комментировать не обязательно.

Что делать, если после комментирования конфигурация не запускается?

Проверьте синтаксис модуля: отсутствие закрывающего */, лишний символ или неправильное размещение комментария может привести к ошибке. Закомментируйте или удалите подозрительный фрагмент, сохраните модуль и повторите запуск.