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

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

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

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

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

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

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

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

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

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

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

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

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

Эта же комбинация клавиш работает и в обратном направлении: если выделите строки, уже являющиеся комментариями, и нажмете Ctrl + /, система автоматически уберет символы //, восстановив код в рабочее состояние. Этот механизм называется переключением (toggle) и является стандартом де-факто для многих современных IDE.

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

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

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

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

В редакторе запросов комментарии часто используются для документирования сложных соединений таблиц или для временного исключения условий изWhere-части. Вы можете разместить комментарий в начале строки или в конце строки с параметрами запроса. Движок запросов корректно проигнорирует такие вставки.

Однако есть важный нюанс: в отличие от модулей объектов, в редакторе запросов иногда могут возникать проблемы с выделением и массовым комментированием через Ctrl + / в старых версиях платформы. В таких случаях рекомендуется использовать функционал "Параметры" или вручную проставлять символы, если автоматизация не срабатывает.

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

Объект 1С	Символ комментария	Горячие клавиши	Особенности
Модуль объекта	//	Ctrl + /	Полная поддержка IDE
Редактор запросов	//	Ctrl + / (зависит от версии)	Игнорируется движком запросов
Внешние обработки	//	Ctrl + /	Аналогично модулям
Макеты (Табличный документ)	Не применяется	Нет	Ячейки скрываются свойствами

Использование препроцессора для условного кодирования

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

Директивы #Если, #Иначе и #КонецЕсли позволяют создавать логические блоки, которые будут включены в скомпилированный код только при выполнении определенных условий. Это мощный инструмент для написания кросс-платформенного кода или кода, совместимого с разными версиями конфигураций.

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

#Если Клиент Тогда
// Этот код виден только в тонком клиенте
Сообщить("Работа в тонком клиенте");
#Иначе
// Этот блок закомментирован для тонкого клиента
// Сообщить("Работа в толстом клиенте");
#КонецЕсли

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

⚠️ Внимание: Директивы препроцессора обрабатываются до компиляции модуля. Если условие ложно, код внутри блока вообще не анализируется синтаксическим анализатором. Ошибки в таком коде обнаружены не будут.

Почему препроцессор лучше комментариев?

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

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

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

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

Также стоит избегать закомментированных блоков кода, которые планируется удалить в будущем ("мертвый код"). Такие вставки засоряют модуль и вводят в заблуждение. Если код больше не нужен — удалите его. Если он может понадобиться позже — сохраните его в системе контроля версий (Git), а не в теле модуля.

• 📝 Используйте комментарии для объяснения бизнес-логики, а не перевода кода на русский язык.
• 🗑️ Не храните в модуле закомментированные куски старого кода, используйте систему версионирования.
• 🎨 Соблюдайте единый стиль: ставьте пробел после // для улучшения читаемости текста комментария.
• 🔍 Обновляйте комментарии при изменении кода, устаревший комментарий хуже, чем его отсутствие.

Хорошим тоном считается использование специальных маркеров в комментариях, таких как TODO (сделать позже), FIXME (исправить ошибку) или NOTE (важное примечание). Многие инструменты анализа кода для 1С умеют искать такие маркеры и выводить их в отдельный список задач для разработчика.

Анализ кода и работа с закомментированными участками

Современные инструменты статического анализа кода, такие как SonarQube с плагином для 1С или встроенные проверки в EDT (Enterprise Development Tools), уделяют особое внимание качеству комментариев. Они могут предупреждать разработчика о слишком длинных комментариях, отсутствии документации у публичных методов или наличии подозрительных закомментированных блоков.

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

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

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

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

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

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

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

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

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

Существует ли возможность блочного комментирования в 1С?

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

Что делать, если Ctrl + / не комментирует код?

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