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

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

Синтакс-помощник 1С: как открыть и эффективно использовать

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

Синтакс-помощник — встроенный справочник по языку 1С, методам, свойствам и событиям объектов платформы. Он открывается только в конфигураторе и недоступен в режиме «1С:Предприятие», поэтому первое условие — запустить базу именно через конфигуратор, а не через обычный ярлык пользователя.

Чаще всего помощник вызывают из модуля кода, чтобы быстро посмотреть описание метода, его параметры и примеры использования. Для этого есть несколько способов: через меню, через контекстное меню и по горячим клавишам. Ниже разобраны все варианты, включая ситуации, когда помощник не открывается или показывает пустое окно.

Что такое синтакс-помощник и когда он нужен

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

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

Дополнительное преимущество — помощник работает офлайн и не требует подключения к интернету. Все материалы хранятся локально в каталоге установки платформы.

Как открыть синтакс-помощник через меню и горячие клавиши

Базовый способ — через главное меню конфигуратора. Запустите конфигуратор, откройте меню «Справка» и выберите пункт «Синтакс-помощник». Откроется отдельное окно с деревом разделов слева и текстом описания справа.

Быстрее всего помощник вызывается сочетанием клавиш Ctrl+Shift+F1. Это работает из любого окна конфигуратора, даже если ни один модуль не открыт. Окно помощника можно закрепить рядом с редактором модуля, чтобы видеть справку одновременно с кодом.

Открытие справки по конкретному методу

Если нужно описание конкретной функции или метода, не обязательно искать его в дереве вручную. Откройте модуль, поставьте текстовый курсор на имя метода (например, на слово «НайтиПоНаименованию») и нажмите Ctrl+F1. Помощник откроется сразу на нужной странице.

Тот же результат даёт контекстное меню: щёлкните правой кнопкой мыши по имени метода и выберите пункт «Синтакс-помощник» или «Найти в синтакс-помощнике» — название пункта зависит от версии платформы.

Порядок действий
  1. 1
    Запустите базу через конфигуратор, а не через «1С:Предприятие»
  2. 2
    Откройте нужный модуль с кодом (общий модуль, модуль объекта или формы)
  3. 3
    Поставьте курсор на имя метода или функции
  4. 4
    Нажмите Ctrl+F1 для контекстного открытия или Ctrl+Shift+F1 для открытия помощника целиком
  5. 5
    Проверьте, что справа отобразилось описание метода с параметрами и примером

Как искать информацию внутри помощника

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

Дерево разделов слева сгруппировано логически: «Глобальный контекст», «Работа с данными», «Прикладные объекты», «Универсальные коллекции значений» и другие. Если вы не знаете точного имени метода, но понимаете задачу (например, работа со строками), удобнее раскрыть соответствующий раздел и просмотреть список функций.

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

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

Настройка отображения и фильтров

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

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

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

Почему синтакс-помощник не открывается: типичные причины

Самая частая причина — попытка открыть помощник в режиме «1С:Предприятие». Там его нет по определению: справка по языку доступна только разработчику в конфигураторе. Проверьте, каким ярлыком вы запускаете базу.

Вторая причина — повреждённые или отсутствующие файлы справки в каталоге установки платформы. Это бывает после неполной установки или ручной чистки каталога. Лечится восстановлением платформы через установщик или переустановкой дистрибутива той же версии.

Третья ситуация — Ctrl+F1 не находит метод, потому что курсор стоит не на имени метода, а на переменной или пользовательской процедуре. Помощник описывает только встроенные объекты платформы; для собственных процедур конфигурации используйте поиск по конфигурации или переход к определению (F12 в новых версиях).

Типичные ошибки
01
Искать помощник в режиме «1С:Предприятие» — его там нет, нужен конфигуратор
02
Нажимать Ctrl+F1 на имени собственной процедуры — помощник показывает только встроенные объекты платформы
03
Игнорировать фильтры по клиенту — метод найден, но в тонком клиенте он недоступен и код падает с ошибкой
04
Копировать пример без проверки версии платформы — пример может использовать возможности более нового релиза

Альтернативные способы получить справку

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

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

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

Синтакс-помощник в конфигураторе

Точное соответствие установленной версии платформы, работает офлайн; требует запущенного конфигуратора

Документация из дистрибутива

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

Портал ИТС

Актуальные описания и дополнительные статьи; требуется интернет и действующая подписка

Подсказка редактора кода

Мгновенный показ параметров при вводе; не содержит полного описания и примеров

Как проверить, что всё работает правильно

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

Для контрольной проверки поставьте курсор на любую встроенную функцию, например «Сообщить», и нажмите Ctrl+F1. Если открылась страница с описанием процедуры «Сообщить» — помощник работает корректно, включая контекстный вызов.

Контрольные точки

Как проверить результат

Дерево разделов слева
Норма

Разделы раскрываются, видны подразделы глобального контекста

Тревожный признак

Дерево пустое или не раскрывается — проблема с файлами справки

Ctrl+F1 на встроенной функции
Норма

Открывается страница с описанием и примерами

Тревожный признак

Ничего не происходит или открывается главная страница помощника

Поиск по строке
Норма

По запросу «Найти» выводится список подходящих методов

Тревожный признак

Поиск ничего не находит даже по заведомо существующим именам

Часто задаваемые вопросы

Можно ли открыть синтакс-помощник в режиме «1С:Предприятие»?

Нет. Помощник — инструмент разработчика и доступен только в конфигураторе. Пользователю в режиме «Предприятие» доступна только справка по прикладному решению через меню «Справка».

Почему Ctrl+F1 не находит мой метод?

Контекстный вызов работает только для встроенных объектов платформы. Если курсор стоит на собственной процедуре конфигурации, помощник её не найдёт — используйте поиск по конфигурации или переход к определению процедуры.

Помощник открывается, но окно пустое. Что делать?

Скорее всего, повреждены файлы справки в каталоге установки платформы. Запустите установщик платформы той же версии и выберите восстановление, либо переустановите платформу полностью.

Как смотреть описание методов, недоступных в тонком клиенте?

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

Совпадает ли помощник с описаниями в интернете?

Не всегда. Состав методов зависит от версии платформы. Описание в вашем помощнике точно соответствует установленной версии, а материалы в сети могут относиться к другому релизу.

Можно ли искать методы по английскому имени?

Да. Поиск в помощнике работает по обоим вариантам синтаксиса: можно ввести, например, «Find» вместо «Найти», и будут показаны соответствующие методы.

Итог

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

Синтакс-помощник открывается только в конфигураторе: через меню «Справка», по Ctrl+Shift+F1 или контекстно по Ctrl+F1 с курсором на имени встроенного метода. Если помощник пустой или не открывается — проверьте режим запуска и целостность установки платформы.