Разработка и Конфигурация · 8 мин
Синтакс-помощник 1С: как пользоваться встроенной справкой разработчика
Как открыть и использовать синтакс-помощник в 1С: поиск методов, горячие клавиши, работа со свойствами объектов, типичные ошибки и ответы на вопросы.
Синтакс-помощник — это встроенная справочная система платформы 1С:Предприятие, в которой собрано описание всех объектов встроенного языка: методов, свойств, событий, конструкторов и системных перечислений. Он заменяет разработчику внешнюю документацию и позволяет прямо из конфигуратора уточнить, какие параметры принимает метод, что возвращает функция и какие значения допустимы для свойства.
Инструмент доступен в любой редакции платформы и не требует дополнительной установки: он поставляется вместе с конфигуратором. При этом многие разработчики используют его неэффективно — ищут только через полный текст, хотя контекстный вызов по нажатию клавиши решает ту же задачу за секунду.
Ниже разобраны способы открытия помощника, приёмы поиска, работа с описаниями объектов, ограничения инструмента и типичные ошибки, которые мешают быстро находить нужную информацию.
Как открыть синтакс-помощник
Основной способ — меню конфигуратора: «Справка» → «Синтакс-помощник». Окно откроется в отдельной панели, обычно в правой части конфигуратора, но его можно перетащить и закрепить в удобном месте. Второй способ — кнопка с иконкой книги на панели инструментов, если она добавлена.
Самый быстрый вариант — контекстный вызов. Установите курсор на имя метода или свойства в модуле и нажмите F1 (или Ctrl+F1 в зависимости от настроек). Помощник откроется сразу на странице описания этого оператора, без ручного поиска. Это работает для методов глобального контекста, методов объектов и системных перечислений.
- 1Откройте конфигуратор и меню «Справка» → «Синтакс-помощник»
- 2Закрепите панель помощника рядом с окном модуля
- 3Откройте любой модуль, поставьте курсор на знакомый метод и нажмите F1
- 4Проверьте, что помощник открыл нужную страницу описания
Структура окна и способы поиска
Окно синтакс-помощника состоит из двух частей: панели навигации и области с текстом описания. В панели навигации доступны несколько вкладок — «Содержание», «Индекс» и «Поиск». Каждая решает свою задачу, и переключение между ними — основной навык эффективной работы.
Вкладка «Содержание» показывает иерархическое дерево: глобальный контекст, универсальные коллекции значений, прикладные объекты (справочники, документы, регистры), общие объекты. Дерево удобно, когда нужно изучить объект целиком — например, посмотреть все методы менеджера справочника.
Вкладка «Индекс» — это алфавитный список всех операторов, методов и свойств. Начните вводить имя, и список отфильтруется. Вкладка «Поиск» выполняет полнотекстовый поиск по всем разделам, включая тексты описаний и примеры кода.
Какой способ поиска выбрать
Подходит, когда метод уже написан в коде и нужно уточнить параметры. Ограничение: работает только для известных платформе имён.
Подходит, когда помните примерное имя метода, но не знаете, к какому объекту он относится.
Подходит для поиска по смыслу, например «получить остатки». Ограничение: выдаёт много лишних результатов.
Подходит для изучения нового объекта: видны все методы, свойства и события в одном месте.
Как читать описание метода или свойства
Страница описания метода устроена единообразно: сначала синтаксис вызова с перечнем параметров, затем описание каждого параметра с типом и признаком обязательности, далее возвращаемое значение, описание поведения и пример использования. Внизу часто указаны ограничения: доступность на сервере, тонком клиенте, веб-клиенте.
Обращайте внимание на блок «Доступность». Один и тот же метод может быть недоступен в тонком клиенте или требовать серверного контекста. Если код работает в толстом клиенте, но падает в тонком, первым делом проверьте этот раздел описания.
Для объектов (например, «СправочникОбъект») описание разбито на разделы: свойства, методы, события. Полезный приём — открыть страницу объекта и просмотреть список событий, чтобы понять, в каких обработчиках можно разместить свою логику.
Практические приёмы для ускорения работы
Несколько приёмов заметно сокращают время поиска. Во-первых, держите помощник открытым в отдельной панели рядом с модулем: переключение между окнами занимает больше времени, чем взгляд в соседнюю область экрана. Во-вторых, используйте кнопки «Назад» и «Вперёд» в помощнике — они работают как в браузере и позволяют вернуться к предыдущей странице после перехода по ссылке.
В-третьих, комбинируйте помощник с контекстной подсказкой редактора кода (Ctrl+Пробел). Подсказка показывает список методов и сигнатуры прямо при наборе, а помощник даёт развёрнутое описание. Типичная связка: нашли метод через Ctrl+Пробел, нажали F1 для деталей.
Примеры кода на страницах описаний можно копировать прямо в модуль — это рабочие фрагменты, которые обычно достаточно адаптировать под свои имена переменных.
Если контекстный вызов по F1 не срабатывает, чаще всего курсор стоит не на имени метода, а на переменной или комментарии. Выделите имя оператора целиком или поставьте курсор строго на него — тогда помощник откроет нужную страницу.
Ограничения синтакс-помощника
Помощник описывает только встроенный язык и объекты платформы. Он не содержит описания прикладных объектов конкретной конфигурации: процедур общих модулей, методов, написанных разработчиками, особенностей типовых решений. Для них документацию придётся искать отдельно или читать код.
Второе ограничение — помощник не подскажет, какой метод выбрать для бизнес-задачи. Он отвечает на вопрос «как работает этот оператор», но не «каким оператором решить задачу». Для таких вопросов полезнее изучать дерево содержания по тематическим разделам.
Что проверить, если помощник не открывается или ищет плохо
Если синтакс-помощник не открывается вовсе, проверьте целостность установки платформы: файлы справки устанавливаются вместе с ней, и при повреждении дистрибутива помощник может отсутствовать. Переустановка платформы с теми же компонентами обычно решает проблему.
Если поиск не находит заведомо существующий метод, убедитесь, что ищете без опечаток и на нужном языке синтаксиса. В индексе имена приведены на языке, выбранном в настройках конфигуратора; русский и английский варианты имён не смешиваются в одном списке.
Как проверить результат
Открывается страница именно того оператора, на котором стоит курсор
Открывается главная страница помощника или ничего не происходит
В выдаче есть страницы методов и примеры по запросу
Пустой результат при заведомо корректном запросе — проверьте язык интерфейса
Указаны режимы: сервер, толстый/тонкий/веб-клиент
Метод использован в режиме, где он недоступен
FAQ
Чем синтакс-помощник отличается от контекстной подсказки Ctrl+Пробел?
Подсказка показывает список доступных методов и краткие сигнатуры прямо при наборе кода, а помощник даёт полное описание: параметры, возвращаемое значение, доступность, пример. Они дополняют друг друга.
Можно ли открыть синтакс-помощник в режиме «Предприятие»?
Нет, помощник — инструмент разработчика и доступен только из конфигуратора. Пользователям прикладного решения он не нужен.
Почему описание метода в помощнике отличается от поведения в базе?
Скорее всего, помощник открыт из платформы одной версии, а база работает на другой. Сверьте версию платформы в заголовке окна помощника с версией, на которой запущена информационная база.
Есть ли в помощнике описание запросов и языка запросов?
Да, язык запросов описан в отдельном разделе дерева содержания: конструкции SELECT, итоги, виртуальные таблицы, функции. Ищите раздел «Работа с запросами» или используйте индекс по имени конструкции.
Как найти все методы работы со строками?
Откройте дерево содержания: «Глобальный контекст» → «Операции со строками». Там собран полный список функций работы со строковыми значениями с описанием каждой.
Что важно запомнить
Синтакс-помощник — встроенная справка по языку платформы, доступная через меню «Справка» и клавишу F1. Используйте контекстный вызов для уточнения методов, индекс — для поиска по имени, дерево — для изучения объектов. Всегда проверяйте блок «Доступность» и версию платформы.