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

Другое · 5 мин

Как добавить строку комментария в 1С

Как добавить строку комментария в коде 1С: символы //, блоки /* */, комментарии в запросах, проверка результата и безопасные правки модулей.

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

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

Символ // может стоять в начале строки или после кода на той же строке. В первом случае вся строка является комментарием, во втором — комментарием становится только часть после // до конца строки.

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

Как добавить комментарий в модуль

Комментарий в начале строки

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

Комментарий в конце строки и блок комментариев

Чтобы отключить одну исполняемую строку, поставьте // перед ней. Чтобы вернуть код, удалите //. Блоки кода выделяют и комментируют командами редактора, если они доступны, или вручную расставляют // у каждой строки.

Порядок действий
  1. 1
    Откройте модуль в Конфигураторе
  2. 2
    Поставьте // в начале строки или после кода
  3. 3
    Проверьте синтаксис и сохраните изменения

Комментарии в языке запросов

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

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

Ограничения и особенности комментариев

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

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

Проверка результата и безопасные правки

После добавления комментария выполните проверку синтаксиса конфигурации. Признак корректной строки — отсутствие ошибок под строкой и изменение цвета текста комментария в редакторе.

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

Частые ошибки при комментировании кода

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

Также не стоит вкладывать блочные комментарии друг в друга без уверенности в поддержке вложенности, и не использовать комментарии вместо документации по бизнес-процессу.

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

Как проверить, что комментарий добавлен корректно

Откройте модуль после сохранения и найдите строку, начинающуюся с //. Текст должен быть помечен как комментарий, а не как команда.

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

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

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

Текст строки начинается с //
Норма

Редактор подсвечивает строку как комментарий, синтаксис без ошибок

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

Ошибка под строкой или текст выполняется как код

Итоговые рекомендации

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

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

Итог

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

Строка комментария в 1С начинается с //, блок — с /<em> и </em>/, комментарии игнорируются при выполнении, а отключённый код требует проверки на копии базы.

Нужно ли перезапускать 1С после добавления комментария?

Обычно нет. Достаточно сохранить модуль и проверить синтаксис в Конфигураторе; изменения вступят в силу при следующем открытии сеанса или обновлении конфигурации.

Можно ли закомментировать сразу несколько строк?

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

Влияют ли комментарии на скорость работы программы?

Нет, комментарии игнорируются при компиляции и выполнении, поэтому не замедляют работу информационной базы.

Безопасно ли отключать код комментарием в рабочей базе?

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