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

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

Эта статья охватывает все актуальные способы комментирования — от стандартных конструкций до малоизвестных приёмов для опытных программистов. Мы разберём, как работать с модулями объектов, обработками, отчётами и даже внешними файлами (.epf, .erf). Особый акцент сделан на типичные ошибки, которые приводят к синтаксическим ошибкам или неожиданному поведению кода.

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

1. Стандартный способ: конструкция // и / /

Самый распространённый метод — использование символов // для однострочных комментариев и / / для многострочных. Этот синтаксис работает во всех современных версиях платформы 1С:Предприятие 8.3 (включая последние релизы 8.3.23 и выше).

Примеры применения:

• 📌 Однострочный комментарий:

  // Эта строка не будет выполнена
  Сообщить("Привет, мир!");

• 📌 Многострочный комментарий:

  /*
  Процедура РассчитатьЗарплату()
  // Временный код для тестирования
  Возврат Ложь;
  КонецПроцедуры
  */

• 📌 Комментирование части строки:

  Запрос.Текст = "ВЫБРАТЬ // Тут был лишний столбец
  | Номенклатура КАК Товар";

Важное ограничение: конструкция / / не может быть вложенной. То есть такой код вызовет ошибку:

/*
Комментарий 1
/*
Комментарий 2 - ОШИБКА!
*/
*/

2. Комментирование в модулях объектов и формах

В модулях документов, справочников, отчётов и обработок синтаксис комментирования идентичен, но есть специфические случаи. Например, в модуле менеджера нельзя комментировать директивы компиляции (например, &НаКлиенте), так как они обрабатываются на этапе предварительной обработки кода.

Рассмотрим на примере модуля документа РеализацияТоваровУслуг:

Процедура ОбработкаПроведения(Отказ, Режим)
// Проверка заполнения обязательных реквизитов
Если НЕ ЗначениеЗаполнено(Объект.Контрагент) Тогда
Отказ = Истина;
Возврат;
КонецЕсли;

/*
Старая логика расчёта скидок - теперь не используется
Объект.СуммаДокумента = РассчитатьСкидку(Объект.СуммаДокумента);
*/
КонецПроцедуры

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

Процедура ТоварПриИзменении(Элемент)
// Временно отключаем обработчик
// РассчитатьЦену(Элемент);
КонецПроцедуры

3. Комментирование в запросах и динамическом коде

В текстах запросов (Запрос.Текст) и динамически формируемом коде (например, в Выполнить()) действуют особые правила. Здесь нельзя использовать стандартные конструкции 1С, но работают SQL-подобные комментарии:

• 🔹 Однострочный: -- Комментарий (два дефиса)
• 🔹 Многострочный: / Комментарий / (как в SQL)

Примеры:

Запрос.Текст =
"ВЫБРАТЬ
|  Номенклатура.Наименование КАК Товар,
|  -- СуммаБезНДС убрана по требованию бухгалтерии
|  Цена.СуммаНДС КАК НДС
|ИЗ
|  Документ.РеализацияТоваровУслуг.Товары КАК Товары";

Критическая особенность: если вы используете Выполнить() для динамического выполнения кода, комментарии внутри строки должны экранироваться:

Выполнить("Процедура Тест()
|  // Это комментарий внутри Execute
|  Сообщить(""Работает!"");
|КонецПроцедуры");

4. Альтернативные методы: директивы препроцессора

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

Основные директивы:

Пример использования для отладки:

#Если Клиент Тогда
Сообщить("Этот код работает только на клиенте!");
#ИначеЕсли Сервер Тогда
ЗаписатьЛог(ИнформацияОбОшибке(), , , , Истина);
#КонецЕсли

Директивы препроцессора игнорируются в режиме отладки (F5), но влияют на конечный компилируемый код. Это означает, что если вы используете #Если Ложь Тогда, то содержимое блока не попадёт в исполняемый модуль вообще.

5. Комментирование в макетах и внешних файлах

Внешние файлы (.epf, .erf) и макеты (например, макеты печатных форм) имеют свои нюансы. В них нельзя использовать стандартные комментарии 1С, но работают:

• 📄 В .epf/.erf: только // и / / (как в обычных модулях)
• 📄 В макетах HTML: комментарии HTML (<!-- -->)
• 📄 В макетах Текст: никаких специальных конструкций — просто удаляйте или переносите текст в отдельный блок

Пример для макета HTML:

<!--
Этот блок будет скрыт в итоговом документе:
<div>{{ДатаФормирования}}</div>
-->

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

• 🔸 Удаление лишних областей через Область().Очистить()
• 🔸 Условное форматирование с проверкой Ложь

6. Типичные ошибки и как их избежать

Даже опытные разработчики допускают ошибки при комментировании кода. Вот самые распространённые:

⚠️ Внимание: Если закомментировать строку с открывающей фигурной скобкой { (например, в JSON или структуре), это приведёт к ошибке разбора кода. Всегда проверяйте парность скобок после раскомментирования.

Чек-лист ошибок:

1. 🚫 Комментирование директив &НаКлиенте или &НаСервере — это вызовет ошибку компиляции.
2. 🚫 Использование / / внутри строковых литералов: "Текст / комментарий /" не сработает.
3. 🚫 Забытые комментарии в продакшн-коде: они увеличивают размер модуля и могут содержать конфиденциальную информацию.

Как проверить код на наличие "мёртвых" комментариев:

// Поиск по всем модулям (регулярное выражение для Конфигуратора):
Поиск: /\/\.\*\//gs
// Или для однострочных:
Поиск: \/\/.*

7. Автоматизация: горячие клавиши и инструменты

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

• 🔥 Ctrl + / — закомментировать/раскомментировать выделенный блок (работает в 1С:EDT и новых версиях Конфигуратора)
• 🔥 Ctrl + Shift + / — многострочный комментарий для выделенного фрагмента
• 🔥 Рефакторинг → Закомментировать код (меню правой кнопки в модуле)

Для командной работы полезно настроить шаблоны комментариев в 1С:EDT:

1. Перейдите в Window → Preferences → 1C → Editor → Templates
2. Создайте новый шаблон, например, todo с текстом: // TODO: ${cursor} (${date})
3. Теперь при вводе todo + Tab будет вставляться готовый комментарий с датой.

Для крупных проектов рекомендуется использовать Git или SVN для отслеживания изменений. Комментарии типа // Убрано по задаче #1234 помогут коллегам понять контекст изменений.

FAQ: Частые вопросы по комментированию кода в 1С

Процедура МояПроцедура()
Возврат; // Временно отключена
// Основной код...
КонецПроцедуры