Кабинет
На этой странице

Инструменты · Сквозные

platform_docs

R · чтениепо подпискене изменяет проект

Справка синтакс-помощника платформы 1С карточками — тип со всеми членами, метод с синтаксисом, параметрами и возвращаемым значением, свойство; полнотекстовый поиск и дерево разделов. Плюс описание метода вашего проекта и тип выражения в модуле.

обновлено 30.09.2026плагин 0.2.0 · EDT 2025.2Предложить правку или письмом

Когда использовать

  • Проверить сигнатуру метода платформы — info с запросом вида ТаблицаЗначений.Добавить.
  • Не знаете точного имени — search, затем info по заголовку найденного.
  • Посмотреть раздел справки — tree.
  • Что делает метод проекта по его комментарию — comment; какой тип у выражения в модуле — type_at.

Соседние инструменты домена «Сквозные»

Операции

Операции platform_docs
operationЧто делаетНужно передать
infoпо умолчаниюКарточка темы. Тип — обзор со всеми методами, свойствами, конструкторами и событиями; метод — синтаксис, параметры, возвращаемое значение, доступность, устаревание; свойство — тип и доступ. Запрос — имя или Тип.Член, по-русски или по-английски.query или path
searchПолнотекстовый поиск по справке; заголовок найденного годится как запрос для info, путь — как точный адрес.query
treeДерево разделов справки, когда имя неизвестно; без параметров — корень.по желанию path, query, detail
commentКарточка описания метода проекта из его комментария — в том же виде, что info.project, module_fqn, name
type_atТип выражения в методе модуля: переменная, созданная через Новый, или цепочка из текста, например Запрос.Выполнить().Выбрать(). Ответ — тип по шагам цепочки.project, module_fqn, method, expression

Параметры

Параметры platform_docs
Параметр и типОбязательныйОписаниеПо умолчанию
operationстроканетОперация инструмента — значения и их смысл в таблице «Операции».значения: info · search · tree · comment · type_atinfo
projectстрокадля comment, type_atПроект: для info, search, tree — по желанию (определяет версию платформы, по умолчанию первый открытый проект); для comment и type_at — обязателен.—
queryстрокадля searchДля info и tree — имя темы: ТаблицаЗначений или ТаблицаЗначений.Добавить, по-русски или по-английски. Для search — текст поиска.—
pathстроканетДля info и tree: точный путь в справке из предыдущего ответа — найденного, подсказки или дочернего узла. Важнее query.—
versionстроканетДля info, search, tree: версия платформы, например 8.3.24. По умолчанию — версия проекта.—
languageстроканетДля info, search, tree: язык справки — ru или en.значения: ru · enru
detailстроканетТолько для tree: brief — имена и пути; default — плюс вид и количество; full — два уровня вглубь.значения: brief · default · fulldefault
module_fqnстрокадля comment, type_atДля comment и type_at: адрес модуля.—
nameстроканетДля comment: имя метода, описание которого нужно.—
methodстроканетДля type_at: метод, в котором ищется выражение.—
expressionстроканетДля type_at: имя переменной или точная цепочка из текста, например Запрос.Выполнить().Выбрать().—
lineцелоенетДля type_at, по желанию: номер строки выражения — уточнение, если переменная переприсваивается.—
limitцелоенетОкно чтения: сколько строк готового ответа вернуть. По умолчанию 200, максимум 1000.200
offsetцелоенетОкно чтения: номер строки ответа, с которой начать (0 — первая страница). Значение для следующей страницы подсказывает строка *lines: …* в конце ответа.0
filterстроканетРегулярное выражение без учёта регистра. Сужает вывод: оставляет строки ответа, в которых есть совпадение (заголовки секций с совпадениями сохраняются). Применяется до окна чтения.—

Таблица собрана из схемы инструмента, которую получает агент при подключении.

Адреса

fqn не используется. Тема справки — query или path; метод проекта — module_fqn и name.

Пример вызова и ответа

аргументы platform_docs
{ "operation": "info", "query": "ТаблицаЗначений.Добавить" }
ответ инструмента
### 🟢 ТаблицаЗначений.Добавить (ValueTable.Add)

> Σ Method (Function) · 8.3.24 ru

- **syntax:** `Добавить()`
- **availability:** Сервер · ТолстыйКлиент · ВнешнееСоединение
- **path:** `objects/catalog238/methods/Add.html`

Добавляет строку в таблицу значений.

#### Parameters (0)

_(нет)_

#### Returns

- [СтрокаТаблицыЗначений] — Добавленная строка.

#### Example

```bsl
ТЗ = Новый ТаблицаЗначений;
Строка = ТЗ.Добавить();
```

Отказы и ошибки

failed · у типа нет такого члена

Опечатка в имени метода — ответ предлагает ближайшие члены типа и путь к обзору.

ответ инструмента
### 🔴 info — `ТаблицаЗначений.Добавитб`

- **status:** 🔴 failed
- **message:** type «ТаблицаЗначений» has no member «Добавитб» (docs 8.3.24 ru)
- **fix_hint:** overview of all members: info query="ТаблицаЗначений"

#### Did you mean

- Добавить
- ДобавитьКолонку
- Найти
- Очистить

failed · тема не найдена

Такой темы в справке нет — подсказка предлагает полнотекстовый поиск или дерево разделов.

ответ инструмента
### 🔴 info — `СтруктураЗначений`

- **status:** 🔴 failed
- **message:** topic not found in platform docs 8.3.24 ru: «СтруктураЗначений»
- **fix_hint:** full-text: operation=search query="СтруктураЗначений"; browse sections: operation=tree

failed · Unknown operation

Неизвестное значение operation. В ответе — fix_hint: supported: … со списком допустимых операций и секция Did you mean. Допустимо: info, search, tree, comment, type_at.

failed · лицензия

Без действующего ключа инструмент отвечает карточкой failed с сообщением лицензия: … и подсказкой, где ввести ключ; в секции Context — список инструментов, доступных без ключа. Подробнее — Лицензия и бесплатный доступ.

Ограничения

  • Тип выражения выводится для переменных, созданных через Новый, параметров с описанием в комментарии и присваиваний; сложные случаи отмечаются как частичный результат.
  • Справка — той версии платформы, что у проекта; другую задаёт version.
Нашли ошибку — предложите правку.обновлено 30.09.2026

Например: metadata_write, «порт занят», коллекционный адрес.

↑ ↓ выборEnter открыть/ или Ctrl K — открыть поиск