Синтакс-помощник

Панель «Синтакс-помощник»

Панель Синтакс-помощник состоит из двух частей: навигационное окно (вверху) и окно справки (внизу).

Окно справки показывает описание одного типа, метода, свойства, события, параметра.

Панель Синтакс-помощник входит в стандартный состав перспектив 1С:Enterprise.

Открыть панель «Синтакс-помощник»

Нажмите Окно > Показать панель > Другое… > 1С:Предприятие > Синтакс-помощник.

Также можно нажать Ctrl+Shift+F1.

Открыть справку

В навигационном окне дважды кликните на нужном типе, свойстве, методе, событии или параметре.

Найти тип, метод, свойство в содержании

В навигационном окне на вкладке Содержание в строку поиска введите искомую строку.

Поиск выполняется по началу слова или предложения (если в искомой строке есть пробелы). Можно использовать символ «*» (звездочка), который обозначает любой набор символов.

Панель справки c описанием нужного синтаксиса можно открыть из других инструментов 1C:EDT:

Редактор встроенного языка

• Установите курсор на нужный метод, свойство.
• Нажмите Ctrl+F1.
• Откроется панель Синтакс-помощник, у которой в окне справки будет показана справочная информация по этому методу, свойству.
• Если вы хотите получить справку по событию, которое имеет назначаемый обработчик, выделите в имени обработчика имя события (например, выделите НачалоВыбора в имени ФайлКартинкиНачалоВыбора) и нажмите Ctrl+F1.
• Откроется панель Синтакс-помощник на вкладке Поиск. В этой вкладке будут показаны подходящие типы с такими событиями.
• Кликните на нужный тип.
• В окне справки будет показана справочная информация.

Всплывающее окно синтаксической подсказки

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

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

Показать в навигационном окне тот элемент, чья информация открыта в окне справки

• В командной панели у окна справки нажмите Показать в содержании.
• В навигационном окне будет раскрыто дерево типов и выделен нужный элемент.

Настройки

Расположение окон

В командной панели навигационного окна нажмите (Показать меню) — Положение:

• Вертикальное. Навигационное окно сверху, окно справки снизу.
• Горизонтальное. Навигационное окно слева, окно справки справа.
• Автоматически. Расположение окон зависит от соотношения размеров панели. Если ширина панели меньше высоты, то навигационное окно размещается сверху, в противном случае справа. Расположение окон меняется прямо во время изменения размеров панели.
• Только содержимое справки. Навигационное окно скрывается, остается только окно справки.

Размер окон

Можно менять размер окон, перетаскивая разделитель, расположенный между ними. Размеры окон сохраняются в рабочей области при закрытии панели Синтакс-помощник и восстанавливаются при ее открытии или при перезапуске 1C:EDT.

Язык синтаксической справки

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

• окно справки в в контекстной подсказке,
• всплывающее окно синтаксической подсказки,
• в подсказка по параметрам методов,
• окно справки в в диалоге добавления обработчика события.

Чтобы переключить язык в панели Синтакс-помощник, командной панели навигационного окна нажмите (Показать меню) — Язык.

Чтобы переключить язык в окне справки в диалоге добавления обработчика события, нажмите (Язык) справа от строки поиска событий.

Версия платформы, для которой отображается справка

Версия платформы «1С:Предприятие», для которой отображается синтаксическая справка, показана в первой строке окна справки справа.

Чтобы переключить синтакс-помощник на другую версию «1С:Предприятия» (Показать меню) — Версия. В этом меню показываются только те версии, для которых справка установлена.

Изменение версии в этом меню автоматически влияет только на содержание, отображаемое в навигационном окне. Окно справки и вкладка Поиск остаются на той версии платформы, что были.

Чтобы перейти в окне справки на новую выбранную версию, нажмите (Обновить страницу) в командной панели этого окна.

Чтобы изменить версию, по которой на вкладке Поиск показаны результаты, перезапустите этот поиск после изменения версии.

Версия платформы, для которой отображается информация в окне справки в контекстной подсказке, во всплывающем окне синтаксической подсказки, в подсказке по параметрам методов и в окне справки в диалоге добавления обработчика события не меняется и всегда равна той, которая выбрана для проекта.

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

Основные приемы работы

Переход по ссылкам

Справочная информация содержит гиперссылки, по которым можно перейти к описанию упоминаемых типов, методов, свойств и др. Новое описание открывается в этом же окне, заменяя собой старое.

Переход по истории вперед и назад

Чтобы вернуться к предыдущей странице, нажмите (Назад по истории) в командной панели окна справки или в контекстном меню. Чтобы перейти вперед, нажмите (Вперед в истории).

Предыдущие и следующие элементы

Чтобы посмотреть все предыдущие элементы вплоть до первого, нажмите стрелку вниз рядом с (Назад по истории) в командной панели окна справки. Элементы будут показаны в порядке от предыдущего до первого.

Чтобы посмотреть все следующие элементы, нажмите стрелку вниз рядом с (Вперед в истории).

Все элементы истории

Нажмите Открыть журнал в меню, которое открывается по стрелке вниз рядом с командами (Назад по истории) или (Вперед в истории).

Закладки

Закладки — это ссылки на страницы справки. Для каждой страницы справки вы можете сохранить только одну закладку. Имя закладки может быть любым (стандартным или заданным вами).

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

Добавить закладку

Нажмите (Добавить в закладки) в командной панели окна справки. Повторное нажатие удалит эту закладку.

Открыть закладку

На вкладке Закладки дважды кликните на нужной закладке, она откроется в окне справки.

Переименовать закладку

На вкладке Закладки нажмите Переименовать в контекстном меню нужной закладки.

Удалить одну или несколько закладок

На вкладке Закладки выделите одну или несколько закладок и нажмите Удалить в контекстном меню.

Найти закладку

На вкладке Закладки в строку поиска введите искомую строку.

Поиск выполняется по началу слова или предложения (если в искомой строке есть пробелы). Можно использовать символ «*» (звездочка), который обозначает любой набор символов.

Поиск

Вкладка Поиск, расположенная в навигационном окне, позволяет выполнять более глубокий поиск, нежели поиск на вкладке Содержание и на вкладке Закладки.

Во-первых, этот поиск выполняется не только по заголовкам страниц справки, но и по их полному содержанию.

Во-вторых, это полнотекстовый поиск. То есть соответствия ищутся с начала слов, в том числе в составных словах, написанных в стиле CamelCase.

На вкладке Поиск поиск начинает выполняться только после того, как вы введете строку поиска и нажмете Ввод.

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

Найденные вхождения выделяются желтым фоном. Выделяется та часть слова, что остается от запроса после удаления окончания или того, что похоже на окончание. Например слово если превратится в есл.

Результаты поиска представляют собой соединение двух отдельных поисков. Сначала идут точные соответствия, найденные в заголовках страниц (то есть в именах типов, методов, свойств и т.д.). Затем идут результаты обычного полнотекстового поиска, в том числе по содержимому страниц справки.

Всплывающая синтаксическая подсказка

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

В первой строке находится сигнатура, в которой типы значений, имена типов и параметры имеют гиперссылки. Они становятся видны при наведении курсора. По этим ссылкам можно перейти к подробному типов, параметров и т.д. Чтобы вернуться назад, нажмите Назад в командной панели внизу или в контекстном меню.

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

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

Открыть справку в «Синтакс-помощнике»

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

Синтаксическая помощь в контекстной подсказке

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

Функциональность этого окна такая же, как у всплывающей синтаксической подсказки.

Дополнительная методическая информация

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