Синтакс-помощник 1С: как вызвать и работать с ним

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

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

Основные способы вызова синтакс-помощника

Самый быстрый способ — сочетание клавиш Ctrl+Shift+F1. Оно работает в любой момент, когда открыт конфигуратор: откроется отдельное окно с деревом объектов встроенного языка. Если в этот момент в модуле выделено имя метода или свойства, помощник попытается сразу перейти к его описанию.

Второй способ — через главное меню конфигуратора: Справка → Синтакс-помощник. Результат тот же, что и по горячим клавишам, но пункт полезен тем, кто ещё не запомнил сочетание. В меню также видно назначенное сочетание клавиш — его можно использовать как подсказку.

Третий вариант — контекстная справка по клавише F1 или через пункт «Описание» в контекстном меню редактора модуля. Курсор ставится на имя процедуры, функции или свойства, после чего нажимается F1. Если платформа распознаёт объект, откроется страница с его описанием; если нет — появится окно поиска.

1. 1
   Откройте конфигуратор и модуль с кодом
2. 2
   Поставьте курсор на имя метода или выделите его
3. 3
   Нажмите Ctrl+Shift+F1 или F1
4. 4
   Если открылся поиск — введите начало имени метода
5. 5
   Дважды щёлкните нужный элемент в дереве результатов

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

Наиболее продуктивный сценарий — вызов помощника прямо из кода. Поставьте курсор, например, на слово НайтиПоКоду в тексте запроса к справочнику и нажмите Ctrl+Shift+F1. Помощник откроется на странице описания этого метода с указанием синтаксиса, параметров, возвращаемого значения и примера использования.

Контекстный вызов работает только для объектов встроенного языка и методов платформы. Если вы вызовете помощник на имени процедуры, написанной другим разработчиком в общем модуле, платформа не найдёт её в синтакс-помощнике — там описывается только сама платформа, а не код конфигурации. Для перехода к пользовательским процедурам используйте F12 («Перейти к определению»).

Как искать метод, если точное имя неизвестно

Если вы помните только часть названия, откройте помощник и перейдите на закладку «Индекс». Начните вводить начало имени — список будет фильтроваться по мере набора. Это удобно, когда известно, с чего начинается метод: например, «Найти…» выдаст все варианты поиска.

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

Третий путь — навигация по дереву на закладке «Содержание». Объекты сгруппированы по разделам: «Общие объекты», «Справочники», «Документы», «Запросы» и так далее. Если вы работаете, например, с табличным документом, раскройте соответствующую ветку — там будут все его методы и свойства в алфавитном порядке.

Настройка отображения и режимы работы

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

На странице описания метода обратите внимание на блок «Доступность» — там перечислено, где метод можно вызывать: сервер, толстый клиент, тонкий клиент, веб-клиент, мобильное приложение. Игнорирование этого блока — частая причина ошибок вида «Процедура или функция с указанным именем не определена» при исполнении кода на тонком клиенте.

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

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

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

Открылась ли страница нужного метода

Норма

Видны синтаксис, параметры и пример

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

Открылась общая страница или пустой поиск — уточните имя

Доступность метода

Норма

В блоке «Доступность» есть ваш режим клиента

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

Метод доступен только на сервере, а вы вызываете его на клиенте

Соответствие версии

Норма

Метод присутствует в помощнике вашей платформы

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

Метод найден в интернете, но отсутствует в помощнике — версия платформы старше

Типичные ошибки при вызове и их решение

Частая ситуация: Ctrl+Shift+F1 нажато, но открывается окно «Не найдено описание». Причины — курсор стоит не на имени метода, слово написано с опечаткой в самом модуле, либо это пользовательская процедура, которой нет в справке платформы. Решение: выделите слово целиком или воспользуйтесь закладкой «Индекс» с ручным вводом.

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

Иногда разработчики путают синтакс-помощник с окном «Синтаксический контроль» или с подсказкой по Ctrl+Пробел. Это разные инструменты: Ctrl+Пробел показывает контекстный список автоподстановки в редакторе, синтаксический контроль проверяет модуль на ошибки, а помощник — это справочник с описаниями. Для чтения документации нужен именно он.

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

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

Для изучения приёмов разработки, а не отдельных методов, используются документация из комплекта поставки платформы и руководство разработчика — они открываются через меню «Справка». Там описаны архитектурные решения, тогда как синтакс-помощник отвечает на вопрос «какие параметры у этого метода».

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

Ctrl+Shift+F1

Полное описание метода платформы с примерами; не работает для кода конфигурации

Ctrl+Пробел

Быстрая подсказка по параметрам при наборе кода; без подробного описания

F12

Переход к определению любой процедуры конфигурации; не показывает документацию платформы

Меню Справка

Тот же помощник плюс руководство разработчика; медленнее горячих клавиш

FAQ

Какая комбинация клавиш открывает синтакс-помощник в 1С?

Ctrl+Shift+F1 — основное сочетание. Также работает вызов через меню «Справка — Синтакс-помощник», а клавиша F1 открывает контекстную справку по элементу под курсором.

Почему помощник не находит процедуру, которую я вижу в коде?

Синтакс-помощник содержит только описание встроенного языка платформы. Если процедура написана разработчиками конфигурации, её там нет. Для перехода к её тексту поставьте курсор на имя и нажмите F12.

Можно ли пользоваться синтакс-помощником без конфигуратора?

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

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

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

Как понять, где можно вызывать метод — на сервере или на клиенте?

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

Чем закладка «Индекс» отличается от закладки «Поиск»?

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