Hover по именам типов в описаниях методов (BSLDoc) #3990

Идея

При наведении курсора на имя типа в описании метода (BSLDoc — секции // Параметры: и // Возвращаемое значение:) показывать всплывающую документацию этого типа — так же, как hover по типу в других местах. Удобно: прямо из описания метода видеть, что это за тип.

Пример:

// Параметры:
//  Данные - ТаблицаЗначений - входные данные
//
// Возвращаемое значение:
//  СтрокаТаблицыЗначений - найденная строка
Функция НайтиСтроку(Данные) Экспорт

Навести на ТаблицаЗначений / СтрокаТаблицыЗначений → hover с информацией о типе.

Что проверить

Текущее поведение нужно проверить отдельно для:

• инстанцируемых типов (есть конструктор: Массив, ТаблицаЗначений, Структура);
• неинстанцируемых типов (конструктора нет, объект получают как результат метода/свойства: СтрокаТаблицыЗначений, КолонкаТаблицыЗначений, КлючИЗначение, HTTPОтвет, Поток, …).

Также имеет смысл посмотреть пользовательские (ссылочные — справочники/документы) и типы из OneScript-библиотек.

Догадки (не проверено)

• Возможно, hover по типу в описании метода сейчас не реализован вовсе.
• Если реализован — может работать не для всех типов: по более ранним наблюдениям инстанцируемые и неинстанцируемые типы распознаются в LS по-разному, поэтому и hover для них может отличаться.
• Подсветка имени типа в описании не является индикатором резолва: имя красится позиционно (как второй элемент после дефиса), независимо от того, распознан тип или нет. То есть «покрашено» ≠ «резолвится для hover».

Решение намеренно не предлагается — сначала нужно проверить фактическое поведение для обоих видов типов.