Перейти к содержанию

Всплывающая документация

При наведении на символ показывает сигнатуру, тип и описание из комментариев.

Горячие клавиши: наведение мыши

← Все возможности

Всплывающая документация метода

Курсор наводится на вызов метода в коде модуля. Всплывающая подсказка показывает сигнатуру метода и его описание из документирующего комментария.

Для прикладного метода также показываются контексты компиляции: пересечение флагов модуля, директивы метода и условия препроцессора вокруг объявления. Например, у клиентского метода под #Если ВебКлиент будет указан только веб-клиент. Одноимённые объявления в разных ветках имеют собственные контексты.

Отметка «Серверный вызов» появляется, если возможен переход к методу в серверный контекст. Она учитывает директивы формы или команды, экспорт и флаг «Вызов сервера» общего модуля, а также условие объявления. Допустимость конкретного вызова из конкретной процедуры отдельно проверяет диагностика MethodCallUnavailable.

Эти сведения описывают возможности метода и не зависят от включённых диагностик или их выбора проверяемых режимов. Файловые варианты перечисляются отдельно, когда доступность ограничена ими. При неизвестном условии препроцессора, отсутствии сведений о модуле и в OneScript блок контекстов платформы 1С не добавляется. Заведомо исключённое объявление отмечается как не компилирующееся ни в одном контексте.

hover-01-method

Всплывающая документация переменной

Курсор наводится на переменную в коде модуля. Всплывающая подсказка показывает имя переменной и выведенный тип её значения.

При доступном теле вызываемой функции тип результата уточняется по контексту вызывающего метода и ветке препроцессора. Если функция с &НаКлиентеНаСервереБезКонтекста возвращает число под #Если Сервер, а строку под #Иначе, по умолчанию переменная в клиентской процедуре получает тип Строка, в серверной — Число. При включённой общей настройке supportThickClientFileMode клиентский результат включает и Число: в файловом толстом клиенте символ Сервер истинен даже в клиентской процедуре формы. Та же настройка применяется к перечню контекстов метода и инлей-подсказкам.

hover-02-variable

Всплывающая документация платформенного метода

Курсор наводится на платформенную функцию СтрДлина в коде. Всплывающая подсказка показывает её сигнатуру, тип возвращаемого значения и описание из документации платформы.

hover-03-platform-method

Всплывающая документация конструктора класса OneScript

Курсор наводится на конструктор класса OneScript в выражении Новый. Всплывающая подсказка показывает сигнатуру конструктора и описание класса.

hover-04-oscript-constructor

Всплывающая документация ключевого слова

Курсор наводится на ключевое слово языка в коде модуля. Всплывающая подсказка показывает описание этого ключевого слова.

hover-05-keyword

Тип переменной из поля структуры

Курсор наводится на переменную НомерЗаказа, которой присвоено Заказ.Номер. Всплывающая подсказка показывает тип Строка, выведенный из описания поля структуры в BSLDoc-комментарии.

hover-06-struct-field

Вывод типа переменной из выражения

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

hover-07-inferred-type

Всплывающая документация общего модуля

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

hover-08-common-module

OneScript: всплывающая документация аннотации

Курсор наводится на использование аннотации &Кэшировать в OneScript-модуле. Всплывающая подсказка показывает описание этой аннотации.

hover-09-os-annotation


← Назад: Поиск использований · Вперёд: Подсказка по параметрам →