Панель документации
Справка 1С:Элемент внутри редактора: дерево содержания, полнотекстовый поиск, страница по символу и переходы из конструктора – всё из вашего дистрибутива платформы.
Расширение показывает справку платформы внутри редактора, отдельным контейнером Документация (1С:Элемент) на панели действий. Это тот же справочник, что и на сайте документации, только собран он из вашего дистрибутива 1С:Элемент. Значит, он совпадает с версией платформы, которой вы пользуетесь, и работает без сети.
Что внутри
- Дерево “Содержание” – оглавление, собранное вручную и совпадающее с сайтом: руководство
разработчика, руководство администратора, типы языка (
Стд,Стд::Коллекции→Массив, …), свойства элементов проекта и компонентов интерфейса (ключи их описаний в yaml), схема процесса интеграции, язык запросов и глоссарий. Разделы внутри страницы (Иерархия типа,Примеры,Литералы) вложены в ее узел, поэтому клик ведет сразу к нужному месту. - Страница открывается вкладкой редактора сбоку и не забирает фокус. На ней код, таблицы и картинки статьи, кнопка Копировать у примеров и ссылка Первоисточник на ту же страницу сайта. Внутренние ссылки ведут к другим страницам в этой же вкладке, а дерево “Содержание” встаёт на открытую страницу.
- Поиск живёт за кнопкой в шапке дерева и за командой XBSL: поиск по документации. Он полнотекстовый по всему справочнику и обоим руководствам, а выбор из списка открывает страницу.
Как сюда попадают
На вопрос “что это такое” у всего расширения отвечает одна эта панель:
| Откуда | Что делает |
|---|---|
Наведение на имя в .xbsl |
подсказка показывает описание и ссылку Документация, клик по ней открывает страницу. Над членом типа показан блок самого члена: сигнатура и что делает вызов. Ссылка тогда открывает страницу на этом члене |
| Контекстное меню редактора, XBSL: документация по символу | страница типа под курсором. У члена это страница, прокрученная к нему. Если имя объявлено несколькими типами, предлагается выбор из этих типов |
| Палитра конструктора, Открыть документацию | страница компонента, который вы собираетесь вставить. Краткое описание видно и в подсказке элемента палитры |
| Дерево “Содержание” и поиск | обычная навигация по справочнику |
Член описан там, где его объявили. Массив.Размер открывает страницу предка, который его
объявил: у наследника о члене нет ни слова. Когда одно имя объявлено несколькими неродственными
типами, на выбор предлагаются эти типы, и строкой под каждым идёт блок члена с его страницы. У
остальных имён без своей страницы кандидаты ранжируются по приёмнику перед точкой:
Задание.Настроить предпочтёт страницы запланированного задания странице одноимённого раздела
руководства.
Имя, которое объявил проект, платформенным членом того же написания не объясняется. Слов у
проекта и платформы много общих: Записать у своего модуля найдётся не реже, чем у платформы.
На такое имя основная подсказка отвечает карточкой проекта – методом, его сигнатурой и файлом,
в котором он лежит. Раньше под этой карточкой приписывался ещё и блок документации, и читатель
получал платформенный член, никак не связанный с методом перед ним. Отсекает это сам индекс
проекта. Второго перечня “что считать проектным именем” не заводили: чем ответила подсказка –
объектом, методом модуля, компонентом формы, табличной частью, значением перечисления, – то и
есть ответ проекта, и блок в него не лезет. Поиск по этому слову панель по-прежнему предлагает.
Страница у слова может и быть, просто она не отвечает на вопрос “что это за имя здесь”.
Что нужно
- Режим LSP (
pip install "xbsl[lsp]"): базу документации держит сервер, а расширение только спрашивает и показывает. - Данные документации, собранные из вашего дистрибутива 1С:Элемент – см. Данные о языке.
Без данных панель не падает. Она сообщает, что документация недоступна, а остальные возможности расширения продолжают работать.
Для скриптов и агентов
Тот же справочник доступен вне редактора:
- MCP –
docs_searchдля полнотекстового поиска,docs_pageдля статьи по идентификатору иdocs_symbolдля документации типа или его члена. Своей страницы у члена нет, поэтому он отвечает своим блоком со страницы типа. Оба страничных инструмента умеют отвечать кратко (brief– краткое описание и имена разделов) и одним разделом (section), когда статья целиком больше, чем нужно вопросу. Именно так ИИ-агент сверяет API платформы, не выходя в сеть. - LSP – запросы
xbsl/docsAvailable,xbsl/docsSearch,xbsl/docsPage,xbsl/docsTree,xbsl/docsForSymbolиxbsl/hoverDoc. Над ними любой редактор с поддержкой LSP может собрать свою панель. Последние два отвечают на член так же, какdocs_symbol: страницей объявившего типа, именем члена и идентификатором его заголовка.
docs_symbol также находит члены, создаваемые платформой у компонентов интерфейса проекта:
СобственнаяМодифицированность, РассчитаннаяМодифицированность и ОтслеживатьИзменениеДанных.
Они описаны в статье о типах компонентов. Ответ содержит страницу, блок члена и его section.
Смежное
- Визуальный конструктор – палитра и панель свойств, откуда сюда ведут переходы.
- Расширение VS Code – остальные возможности расширения.