Как в 1С добавить комментарий: пошаговая инструкция

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

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

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

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

Чтобы добавить комментарий, откройте документ или элемент справочника и найдите поле «Комментарий». Обычно оно расположено в нижней части формы, либо на вкладке «Дополнительно», либо в группе, которая раскрывается по кнопке «Ещё». Введите текст и нажмите «Записать» или «Провести и закрыть».

1. 1
   Откройте нужный документ или элемент справочника
2. 2
   Найдите поле «Комментарий» внизу формы или на вкладке «Дополнительно»
3. 3
   Введите текст комментария
4. 4
   Нажмите «Записать» или «Провести и закрыть»
5. 5
   Откройте документ повторно и убедитесь, что текст сохранился

Если документ уже проведён и участвует в движениях по регистрам, редактирование комментария безопасно: изменение этого поля не влияет на проводки и остатки, так как комментарий — информационный реквизит. Однако в закрытом периоде потребуется право на изменение документов этого периода.

Если поля «Комментарий» нет на форме

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

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

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

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

// Рассчитываем скидку по условиям договора
Если СуммаДокумента > 100000 Тогда
	Скидка = 5; // процент скидки, согласован с коммерческим отделом
КонецЕсли;

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

Хороший комментарий объясняет «почему», а не «что»: код и так показывает, что происходит, а пояснение должно фиксировать причину решения, ссылку на задачу или особенность учёта. Избыточные комментарии к очевидным строкам только засоряют модуль.

Комментарии в запросах

В тексте запроса на встроенном языке запросов 1С также используется двойной слэш //. Такой комментарий можно ставить в конце строки или на отдельной строке внутри конструктора запроса и в коде модуля, где запрос задан строкой.

ВЫБРАТЬ
	Продажи.Номенклатура, // только товары основного склада
	СУММА(Продажи.Количество) КАК Количество
ИЗ
	РегистрНакопления.Продажи КАК Продажи
СГРУППИРОВАТЬ ПО
	Продажи.Номенклатура

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

Комментарий при работе с хранилищем конфигурации

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

Пишите комментарии к версиям содержательно: «Исправлен расчёт скидки при частичной оплате, задача №145» полезнее, чем «правки» или «изменения». По хорошо заполненной истории можно быстро найти версию, в которой появилась ошибка, и откатиться на предыдущую.

Как проверить, что комментарий сохранился

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

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

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