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

Разработка и Конфигурация · 9 мин

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

Как добавить строку комментария в 1С: символ // в коде, горячие клавиши, поле «Комментарий» в документах и справочниках, типичные ошибки и FAQ.

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

Помимо комментариев в коде, пользователи часто имеют в виду другое действие — заполнение поля «Комментарий» в документах, справочниках и задачах. Это отдельный сценарий: поле хранится в базе данных, выводится в списках и печатных формах (если предусмотрено конфигурацией) и доступно обычному пользователю без конфигуратора. Ниже разобраны оба сценария.

Важно различать, где именно нужен комментарий: в программном модуле (доступен только разработчику), в форме документа (виден пользователям) или в настройках отчёта. От этого зависит инструмент и порядок действий.

Как добавить комментарий в коде 1С через символ //

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

// Рассчитываем скидку по условиям договора

СуммаСкидки = СуммаДокумента * ПроцентСкидки / 100; // скидка в процентах

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

Ограничение: комментарий действует только до конца текущей строки. Многострочных комментариев вида / ... /, как в некоторых других языках, во встроенном языке 1С нет — каждую строку нужно начинать с //.

Как закомментировать несколько строк сразу горячими клавишами

Когда нужно временно отключить блок кода, вручную расставлять слэши неудобно. В конфигураторе и в 1С:EDT есть групповая операция: выделите нужные строки мышью или через Shift со стрелками, затем нажмите Ctrl + /. Перед каждой выделенной строкой появится //.

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

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

Порядок действий
  1. 1
    Откройте модуль в конфигураторе
  2. 2
    Выделите строки, которые нужно закомментировать
  3. 3
    Нажмите Ctrl+/ — перед строками появится //
  4. 4
    Запустите проверку модуля и убедитесь в отсутствии синтаксических ошибок
  5. 5
    Чтобы вернуть код, снова выделите строки и нажмите Ctrl+/

Комментарии в запросах и текстовых шаблонах

Внутри текста запроса 1С (язык запросов) комментарии тоже поддерживаются и оформляются тем же символом //. Это удобно для пояснения секций ВЫБРАТЬ, ГДЕ, СГРУППИРОВАТЬ ПО в сложных запросах.

Запрос.Текст =

"ВЫБРАТЬ

| Продажи.Номенклатура,

| СУММА(Продажи.Сумма) КАК Сумма

|ИЗ

| РегистрНакопления.Продажи КАК Продажи

|ГДЕ

| Продажи.Период МЕЖДУ &НачалоПериода И &КонецПериода // фильтр по периоду

|СГРУППИРОВАТЬ ПО

| Продажи.Номенклатура";

Учтите: конструктор запроса при перезаписи текста может удалить комментарии, добавленные вручную. Если запрос часто редактируется через конструктор, дублируйте важные пояснения обычным комментарием перед строкой Запрос.Текст = ....

Как заполнить поле «Комментарий» в документе или справочнике

В типовых конфигурациях (1С:Бухгалтерия, Управление торговлей, ERP, ЗУП) почти каждый документ и многие элементы справочников имеют стандартное поле «Комментарий». Оно обычно расположено внизу формы, иногда — на отдельной вкладке «Дополнительно».

Чтобы добавить комментарий, откройте документ, прокрутите форму вниз, найдите поле «Комментарий» и введите текст. После записи документа текст сохранится в базе и будет виден другим пользователям, у которых есть доступ к этому документу.

Поле «Комментарий» часто доступно для поиска: в списке документов можно отобрать записи по подстроке из комментария. Это делает его удобным инструментом для служебных пометок — например, «согласовано с руководителем отдела» или «доставка перенесена по просьбе клиента».

Если поля «Комментарий» в форме нет, возможны два варианта: оно скрыто настройкой формы (проверьте «Ещё → Изменить форму») либо в данной конфигурации для этого объекта поле не предусмотрено. Во втором случае добавить его может только разработчик через конфигуратор.

Сравнение вариантов

Комментарий // в коде

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

Поле «Комментарий» в документе

Для пользователей; хранится в базе, видно в форме и доступно для поиска, но не выводится в печать без настройки

Дополнительный реквизит

Когда нужно структурированное пояснение с типом значения и отборами; требует настройки в разделе администрирования

Комментарии в конфигураторе: настройка шаблонов и автоподстановки

Для регулярной работы с комментариями полезно настроить шаблоны текста (Сервис → Шаблоны текста в классическом конфигураторе). Можно создать шаблон, который вставляет стандартный заголовок комментария с указанием задачи, автора и описания изменения — это дисциплинирует командную разработку.

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

// ++ Задача 1452: добавлен учёт комиссии банка

Комиссия = СуммаПлатежа * 0.01;

// -- Задача 1452

Маркеры «++» и «--» вокруг доработанного фрагмента — распространённая практика: по ним легко найти все изменения по конкретной задаче через глобальный поиск по конфигурации.

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

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

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

Для поля «Комментарий» в документе проверка проста: закройте документ и откройте его заново — текст должен сохраниться. Если текст пропал, убедитесь, что документ был записан после ввода, а не просто закрыт.

Типичные ошибки
01
Пробел между слэшами (/ /) — текст не становится комментарием и вызывает синтаксическую ошибку
02
Закомментирована только часть условия внутри выражения — ломается логика или синтаксис конструкции Если...Тогда
03
Комментарий внутри текста запроса удалён конструктором — пояснение потеряно при очередном редактировании
04
Ожидание, что поле «Комментарий» документа попадёт в печатную форму автоматически — обычно требуется доработка макета
05
Хранение паролей и конфиденциальных данных в комментариях кода — они видны всем, у кого есть доступ к конфигуратору

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

Итог

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

В коде 1С комментарий начинается с // и действует до конца строки; для группового комментирования используйте Ctrl+/. В документах и справочниках для пояснений служит поле «Комментарий». Не храните в комментариях конфиденциальные данные и проверяйте модуль после правок.

Частые вопросы

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

Нет, блочных комментариев во встроенном языке 1С не существует. Каждую строку нужно начинать с //. Для большого фрагмента удобнее выделить строки и нажать Ctrl+/ — платформа расставит слэши автоматически.

Почему Ctrl+/ не комментирует строки?

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

Видят ли пользователи комментарии в коде?

Нет. Комментарии в модулях доступны только в конфигураторе. Пользователи работают в режиме предприятия и не видят исходный код. Для пользовательских пояснений используйте поле «Комментарий» в объектах.

Как вывести поле «Комментарий» документа на печать?

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

Удаляются ли комментарии при обновлении конфигурации?

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

Можно ли закомментировать часть строки в середине выражения?

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