Где в конфигураторе 1С найти справку по встроенному языку и как ею пользоваться
Содержание
Синтакс-помощник в 1С 8.3 открывается в конфигураторе через меню Справка → Синтакс-помощник. Быстрее — поставить курсор на слово в модуле и нажать Ctrl+F1: откроется описание именно этого метода или свойства.
Типичная ситуация: дописываете обработку, пишете СтрНайти( и не помните, какой по счёту параметр отвечает за направление поиска. Лезть в интернет не нужно: справка по встроенному языку, языку запросов и типам объектов поставляется вместе с платформой и открывается за секунду, даже без подключения к сети.
Как вызвать синтакс-помощник горячими клавишами
Синтакс-помощник — это встроенная справка платформы по встроенному языку, языку запросов и объектам. Работает он в конфигураторе, в режиме «1С:Предприятие» его нет.
Самый частый способ — контекстный вызов из модуля:
- Откройте модуль (объекта, формы, общий модуль).
- Поставьте курсор внутрь слова, например на
ТекущаяДатаилиЗапрос. - Нажмите
Ctrl+F1.
Платформа найдёт слово в индексе. Если вариант один — сразу откроется страница описания. Если вариантов несколько (например, метод Добавить есть у десятков объектов), появится список, из которого нужно выбрать тип.
💡 Если курсор стоит на пустом месте, Ctrl+F1 откроет помощник на общей странице. Для точного попадания выделите слово целиком.
Рядом с синтакс-помощником работают ещё две подсказки. Их часто путают с ним, хотя это разные инструменты:
| Сочетание | Что делает | Когда удобно |
|---|---|---|
Ctrl+F1 | Открывает описание слова под курсором в синтакс-помощнике | Нужно прочитать про метод целиком: параметры, доступность, пример |
Ctrl+Пробел | Контекстная подсказка: список методов, свойств, переменных | Не помните точное имя метода |
Ctrl+Shift+Пробел | Подсказка параметров открытой функции | Курсор внутри скобок, нужно вспомнить порядок параметров |
F12 | Переход к определению процедуры или функции | Метод описан в общем модуле конфигурации |
Ctrl+Q | Подстановка шаблона текста | Набрали имя шаблона, нужно развернуть заготовку |
Контекстная подсказка и подсказка параметров показывают кратко. Синтакс-помощник — полно: с разделом «Доступность» (клиент, сервер, внешнее соединение) и с версией платформы, с которой метод работает.
Открытие через меню конфигуратора
Если горячие клавиши не срабатывают или нужно просто полистать справку, используйте главное меню:
- Запустите базу в режиме «Конфигуратор».
- Откройте меню
Справка. - Выберите пункт
Синтакс-помощник.
Окно открывается внутри конфигуратора, его можно закрепить сбоку или вынести на второй монитор. Слева — дерево разделов, справа — текст описания.
В окне три вкладки:
- 📚 «Содержание» — дерево разделов. Удобно, когда хотите изучить объект целиком: все свойства и методы
ТаблицаЗначенийв одном месте. - 🔤 «Индекс» — алфавитный список имён. Начинаете вводить
СтрЗа— список сам прокручивается кСтрЗаменить. - 🔎 «Поиск» — полнотекстовый поиск по описаниям. Находит слово не только в названии, но и в тексте. Полезен, когда знаете, что метод делает, но не помните, как он называется.
💡 Индекс ищет по началу имени, поиск — по любому месту текста. Если «Индекс» ничего не нашёл, переключитесь на «Поиск».
Пример: найти метод, не зная его имени
Задача: нужно разбить строку "10;20;30" на части по точке с запятой. Имя функции вылетело из головы.
- Откройте вкладку «Поиск».
- Введите слово
разделитель. - В результатах будут страницы, где это слово встречается в описании параметров. Среди них —
СтрРазделить (StrSplit). - Откройте страницу и проверьте блок «Использование в версии»: функции нет на старых платформах 8.3.
Тот же приём работает для задач вида «округлить», «дополнить нулями», «перевести в верхний регистр». Ищите по смыслу действия, а не по угаданному имени.
Как читать страницу описания
Каждая страница устроена одинаково. Порядок блоков стоит запомнить, чтобы быстро находить нужное:
- Синтаксис — как вызывать, с указанием необязательных параметров.
- Параметры — тип и смысл каждого, значения по умолчанию.
- Возвращаемое значение — тип результата.
- Описание — что делает метод и его особенности.
- Доступность — где метод можно вызвать: тонкий клиент, веб-клиент, сервер, мобильное приложение.
- Использование в версии — с какой версии платформы доступно.
- Пример и См. также — образец кода и связанные страницы.
Смотрите блок «Доступность» до того, как писать код. Метод, доступный только на сервере, вызванный в клиентской процедуре формы, даст ошибку при выполнении, а не при сохранении модуля.
Справка внутри платформы и описание в интернете
Синтакс-помощник поставляется вместе с платформой и работает без интернета. Его содержимое соответствует версии установленной платформы: обновили платформу — обновилась и справка.
Описания лежат в файлах с расширением .hbk в каталоге bin платформы, например C:\Program Files\1cv8\8.3.xx.xxxx\bin\. Отдельно их скачивать не нужно.
Онлайн-описание тоже существует: документация по платформе публикуется на портале ИТС, есть и сторонние сайты с копией справки. Когда это удобно:
| Вариант | Плюсы | Минусы |
|---|---|---|
| Синтакс-помощник в конфигураторе | Работает офлайн, вызывается по Ctrl+F1, совпадает с вашей версией платформы | Нужно открыть конфигуратор |
| Документация платформы на ИТС | Есть руководство разработчика, а не только справочник методов | Нужен доступ к ИТС |
| Сторонние онлайн-копии | Открываются с телефона, можно дать ссылку коллеге | Могут отставать от текущей версии |
⚠️ Если код пишется под конкретную версию платформы у заказчика, сверяйтесь с блоком «Использование в версии». Метод, появившийся в свежей платформе, на старой просто не скомпилируется.
Язык описаний
Имена в синтакс-помощнике показываются на двух языках: Сообщить (Message), СтрНайти (StrFind). Поэтому искать можно и по английскому имени — это помогает, если код в конфигурации написан на английском варианте встроенного языка.
Как найти описание объектов метаданных
Чаще всего спрашивают не про СтрДлина, а про объекты конфигурации: какие методы есть у документа, у менеджера справочника, у набора записей регистра. В синтакс-помощнике они описаны как типы с шаблонным именем.
Возьмём справочник «Номенклатура». В коде вы встречаете три разных типа, и у каждого свои методы:
| Тип в синтакс-помощнике | Что это в коде | Пример методов |
|---|---|---|
СправочникМенеджер.<Имя справочника> | Справочники.Номенклатура | НайтиПоКоду, СоздатьЭлемент, Выбрать |
СправочникОбъект.<Имя справочника> | Объект, полученный через ПолучитьОбъект() | Записать, Удалить, Заблокировать |
СправочникСсылка.<Имя справочника> | Ссылка на элемент | ПолучитьОбъект, Пустая |
Как искать:
- Откройте вкладку «Индекс».
- Введите начало имени типа:
СправочникОбъект,ДокументМенеджер,РегистрСведенийНаборЗаписей. - Откройте страницу — внутри будет список свойств и методов этого типа.
Те же объекты можно найти на вкладке «Содержание» в ветке прикладных объектов: там они разложены по видам — справочники, документы, регистры.
💡 Синтакс-помощник описывает тип в общем виде, а не ваш конкретный справочник. Реквизиты «Номенклатуры» в нём не появятся — их смотрите в дереве конфигурации или через Ctrl+Пробел после точки.
Процедуры самой конфигурации
Экспортные процедуры общих модулей (например, из БСП) в синтакс-помощник не попадают — это код конфигурации, а не платформы. Для них:
F12на имени процедуры — переход к её тексту;- комментарий над процедурой и есть её документация;
- подсказка параметров по
Ctrl+Shift+Пробелв актуальных версиях платформы показывает описание параметров из этого комментария.
Отсюда практический вывод: пишите комментарий-шапку к экспортным процедурам по стандарту. Коллеги увидят его во всплывающей подсказке.
Шаблоны текста и готовые примеры кода
Синтакс-помощник подсказывает, но код за вас не пишет. Для повторяющихся конструкций в конфигураторе есть шаблоны текста — местный аналог сниппетов.
Где их найти и как пользоваться:
- Откройте
Сервис → Шаблоны текста. - В списке есть стандартные шаблоны: условие, цикл, процедура, попытка.
- В модуле наберите имя шаблона и нажмите
Ctrl+Q— платформа развернёт заготовку.
Свой шаблон добавляют в том же окне: задают имя, строку автозамены и текст. Удобно для типовых блоков вроде запроса с выборкой:
Запрос = Новый Запрос;
Запрос.Текст =
"ВЫБРАТЬ
| Номенклатура.Ссылка КАК Ссылка
|ИЗ
| Справочник.Номенклатура КАК Номенклатура";
Выборка = Запрос.Выполнить().Выбрать();
Пока Выборка.Следующий() Цикл
// обработка Выборка.Ссылка
КонецЦикла;
Шаблоны хранятся в файлах .st. Их можно выгрузить и передать коллегам, чтобы вся команда писала типовые конструкции одинаково.
💡 Блоки «Пример» на страницах синтакс-помощника — хороший источник для своих шаблонов. Скопируйте пример, проверьте на тестовой базе, сохраните шаблоном.
Настройка подсказок в параметрах конфигуратора
Поведение подсказок задаётся в Сервис → Параметры, на вкладке «Модули». Там же настраивают редактор: шрифт, цвета, отступы.
Что имеет смысл проверить:
- ⏱ Автоматическое появление контекстной подсказки. Если включено, список методов появляется сам после ввода точки, без
Ctrl+Пробел. Там же задаётся задержка. - 🌐 Вариант встроенного языка. Влияет на то, на каком языке подставляются ключевые слова в шаблонах и подсказках: русском или английском.
- 🧩 Подсказка параметров. Включите, чтобы при вводе открывающей скобки сразу видеть список параметров.
Отдельной настройки «внешнего вида» у самого окна синтакс-помощника почти нет. Его положение и размер конфигуратор запоминает сам.
Если синтакс-помощник не открывается или пустой
Проблемы со справкой обычно связаны с установкой платформы, а не с базой. Подберите свой симптом:
⚠️ Перед переустановкой платформы на сервере или терминальном сервере закройте сеансы пользователей: установка заменяет файлы, которыми пользуются запущенные клиенты. Делайте это вне рабочего времени.
Синтакс-помощник в других средах разработки
Конфигуратор — не единственное место, где пишут код 1С. В других инструментах справка устроена иначе:
- 🖥 1С:EDT. Своя среда на базе Eclipse. Описание методов встроенного языка показывается во всплывающей подсказке при наведении на имя и в отдельной панели справки. Отдельного окна с названием «Синтакс-помощник» привычного вида там нет.
- 📝 VS Code с расширением для BSL. Расширения на основе BSL Language Server показывают описание платформенных методов при наведении и проверяют код по стандартам. Описания берутся из справки платформы, поэтому и здесь важна версия.
- 📖 Стандарты разработки и руководство разработчика. Синтакс-помощник отвечает на вопрос «как вызвать метод». Как правильно строить код, рассказывают стандарты и руководство разработчика — их стоит держать открытыми рядом.
Для обучения и подготовки к сертификации синтакс-помощник незаменим: на экзамене в конфигураторе пользоваться им можно, поэтому навык быстро находить нужную страницу стоит отработать заранее, на обычных задачах.