Инструменты · Сквозные
platform_docs
Справка синтакс-помощника платформы 1С карточками — тип со всеми членами, метод с синтаксисом, параметрами и возвращаемым значением, свойство; полнотекстовый поиск и дерево разделов. Плюс описание метода вашего проекта и тип выражения в модуле.
Когда использовать
- Проверить сигнатуру метода платформы —
infoс запросом видаТаблицаЗначений.Добавить. - Не знаете точного имени —
search, затемinfoпо заголовку найденного. - Посмотреть раздел справки —
tree. - Что делает метод проекта по его комментарию —
comment; какой тип у выражения в модуле —type_at.
Соседние инструменты домена «Сквозные»
Операции
| operation | Что делает | Нужно передать |
|---|---|---|
infoпо умолчанию | Карточка темы. Тип — обзор со всеми методами, свойствами, конструкторами и событиями; метод — синтаксис, параметры, возвращаемое значение, доступность, устаревание; свойство — тип и доступ. Запрос — имя или Тип.Член, по-русски или по-английски. | query или path |
search | Полнотекстовый поиск по справке; заголовок найденного годится как запрос для info, путь — как точный адрес. | query |
tree | Дерево разделов справки, когда имя неизвестно; без параметров — корень. | по желанию path, query, detail |
comment | Карточка описания метода проекта из его комментария — в том же виде, что info. | project, module_fqn, name |
type_at | Тип выражения в методе модуля: переменная, созданная через Новый, или цепочка из текста, например Запрос.Выполнить().Выбрать(). Ответ — тип по шагам цепочки. | project, module_fqn, method, expression |
Параметры
| Параметр и тип | Обязательный | Описание | По умолчанию |
|---|---|---|---|
operationстрока | нет | Операция инструмента — значения и их смысл в таблице «Операции».значения: info · search · tree · comment · type_at | info |
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 · en | ru |
detailстрока | нет | Только для tree: brief — имена и пути; default — плюс вид и количество; full — два уровня вглубь.значения: brief · default · full | default |
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.
Пример вызова и ответа
{ "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=treefailed · Unknown operation
Неизвестное значение operation. В ответе — fix_hint: supported: … со списком допустимых операций и секция Did you mean. Допустимо: info, search, tree, comment, type_at.
failed · лицензия
Без действующего ключа инструмент отвечает карточкой failed с сообщением лицензия: … и подсказкой, где ввести ключ; в секции Context — список инструментов, доступных без ключа. Подробнее — Лицензия и бесплатный доступ.
Ограничения
- Тип выражения выводится для переменных, созданных через
Новый, параметров с описанием в комментарии и присваиваний; сложные случаи отмечаются как частичный результат. - Справка — той версии платформы, что у проекта; другую задаёт
version.