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

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

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

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

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

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

Многие разработчики задаются вопросом о существовании многострочных комментариев, подобных / ... / в C++ или Java. В чистом встроенном языке 1С такой конструкции нет. Это означает, что для комментирования блока из десяти строк вам придется поставить // в начале каждой из них. Именно эта особенность диктует необходимость использования специальных инструментов автоматизации, о которых мы поговорим ниже.

⚠️ Внимание: Не пытайтесь использовать символы звездочки * или решетки # для комментирования кода в модулях объектов. Эти символы имеют другое назначение в синтаксисе 1С или не являются валидными операторами, что приведет к ошибке компиляции.

Горячие клавиши и быстрое комментирование

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

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

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

Работа с комментариями в 1С:EDT

Для профессиональной разработки все больше компаний переходят на среду 1С:EDT (Enterprise Development Tools), построенную на базе Eclipse. В этой среде подход к комментированию кода более гибкий и привычный для разработчиков, переходящих с других языков программирования. Здесь также поддерживается стандартный синтаксис //, но инструменты работы с ним значительно мощнее.

В 1С:EDT вы можете использовать не только горячие клавиши, но и контекстное меню. Выделив необходимый участок кода, нажмите правую кнопку мыши и выберите пункт Toggle Comment (Переключить комментарий). Система автоматически добавит или удалит символы // в начале каждой строки выделения. Это позволяет избежать ситуаций, когда часть кода остается незакомментированной из-за человеческой ошибки.

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

Особенности комментирования запросов

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

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

В консоли запросов вы можете писать многострочные комментарии, используя пару символов / и /. Это единственное место в экосистеме 1С, где поддерживается блочное комментирование нативно. Такой подход крайне удобен при тестировании больших SQL-подобных конструкций, позволяя временно исключать целые таблицы или условия ГДЕ из выборки.

Среда разработки	Символ комментария	Горячие клавиши	Поддержка блоков
Конфигуратор 1С	//	Ctrl + K / Ctrl + Shift + K	Нет (эмуляция через цикл)
1С:EDT	//	Ctrl + /	Нет (стандарт языка)
Консоль запросов	// или / /	Отсутствуют	Да (/ ... /)
Модуль формы	//	Ctrl + K	Нет

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

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

Если вы работаете в консоли кода (внешняя обработка для выполнения произвольного кода), помните, что любые изменения, внесенные в код через консоль, не сохраняются в конфигурации базы данных, если вы не скопируете их вручную. Здесь комментирование используется преимущественно для быстрой проверки гипотез: "А что будет, если не вызывать эту процедуру?".

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

Секрет быстрой навигации

В Конфигураторе, если зажать Ctrl и кликнуть по номеру строки в окне ошибок, курсор сразу перейдет к проблемному месту. Это работает даже если строка закомментирована, но ошибка кэшировалась.

Лучшие практики и стандарты оформления

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

Используйте комментарии для пометки временных решений ("костылей"), которые планируется исправить в будущем. Для этого часто используют специальные метки, такие как // TODO: или // FIXME:. Многие современные инструменты анализа кода, включая встроенные в 1С:EDT, умеют подсвечивать такие метки в отдельном списке задач, помогая не забыть о технических долгах.

При комментировании больших блоков кода, которые вы планируете удалить позже, но пока боитесь это сделать, используйте префикс // УДАЛИТЬ:. Это позволит при проведении аудита кода или перед релизом быстро найти все места, требующие чистки, с помощью обычного поиска по конфигурации.

⚠️ Внимание: Никогда не комментируйте код, содержащий чувствительные данные (пароли, ключи шифрования), просто оставляя их в тексте. Даже закомментированный пароль остается в исходном коде конфигурации и может быть прочитан любым пользователем с правами на просмотр модулей. Такие данные нужно удалять полностью.

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

Одной из самых распространенных ошибок является "закомментированный код в продакшене". Разработчики часто оставляют большие куски неработающего кода в надежде, что "когда-нибудь пригодится". Это раздувает размер модулей, усложняет чтение и может привести к случайному раскомментированию и запуску ошибочной логики. Правило хорошего тона: если код не нужен — удаляйте его, система контроля версий (Git) сохранит историю.

Другая ошибка — использование комментариев для отключения отладочного вывода в рабочей базе. Часто можно встретить конструкции вида // Сообщить("Отладка: " + Значение);. В производственной среде такой код лучше выносить в отдельную процедуру логирования, которая управляется настройкой константы или регистра сведений, а не простым комментированием строк.

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

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

Нативного синтаксиса для многострочного комментария (как / /) во встроенном языке 1С не существует. Однако в редакторе Конфигуратора и 1С:EDT вы можете выделить несколько строк и нажать Ctrl + K, что автоматически поставит // в начале каждой строки выделения, имитируя блочное комментирование.

Как закомментировать код внутри текста запроса?

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

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

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

Что делать, если горячие клавиши Ctrl+K не работают?

Проверьте, не перехвачены ли клавиши другими программами (например, антивирусом или утилитами скриншотов). Также убедитесь, что курсор находится именно в окне редактора модуля, а не в дереве метаданных или окне свойств. В 1С:EDT сочетание может отличаться в зависимости от темы оформления.