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