Как заставить VSCode отображать аргументы функций моих библиотек при наведении

Я написал библиотеку JavaScript, и я пытаюсь понять, как я могу показать параметры/определения функции, когда пользователь наводит на них курсор в VSCode (я вижу это в других библиотеках и не замечаю в них ничего особенного). Я уверен, что это что-то простое, но я просто не понимаю, как бы я это сделал. Ссылка на проект здесь: https://github.com/isaacgr/jaysonic

Я попытался добавить комментарии в стиле jsdoc к определениям классов, но в целом я не уверен, что попробовать. Я был бы признателен, если бы кто-нибудь мог указать мне в правильном направлении.

Примером может служить то, что я вижу с JSON.parse.

Поведение ключевого слова "this" в стрелочной функции в сравнении с нормальной функцией
Поведение ключевого слова "this" в стрелочной функции в сравнении с нормальной функцией
В JavaScript одним из самых запутанных понятий является поведение ключевого слова "this" в стрелочной и обычной функциях.
Концепция локализации и ее применение в приложениях React ⚡️
Концепция локализации и ее применение в приложениях React ⚡️
Локализация - это процесс адаптации приложения к различным языкам и культурным требованиям. Это позволяет пользователям получить опыт, соответствующий...
Улучшение производительности загрузки с помощью Google Tag Manager и атрибута Defer
Улучшение производительности загрузки с помощью Google Tag Manager и атрибута Defer
В настоящее время производительность загрузки веб-сайта имеет решающее значение не только для удобства пользователей, но и для ранжирования в...
Безумие обратных вызовов в javascript [JS]
Безумие обратных вызовов в javascript [JS]
Здравствуйте! Юный падаван 🚀. Присоединяйся ко мне, чтобы разобраться в одной из самых запутанных концепций, когда вы начинаете изучать мир...
Система управления парковками с использованием HTML, CSS и JavaScript
Система управления парковками с использованием HTML, CSS и JavaScript
Веб-сайт по управлению парковками был создан с использованием HTML, CSS и JavaScript. Это простой сайт, ничего вычурного. Основная цель -...
JavaScript Вопросы с множественным выбором и ответы
JavaScript Вопросы с множественным выбором и ответы
Если вы ищете платформу, которая предоставляет вам бесплатный тест JavaScript MCQ (Multiple Choice Questions With Answers) для оценки ваших знаний,...
0
0
410
1
Перейти к ответу Данный вопрос помечен как решенный

Ответы 1

Ответ принят как подходящий

Код Visual Studio использует IntelliSense для автозаполнения, подобного тому, о котором вы упомянули, а в JavaScript они основаны в основном на определениях TypeScript. Если проект уже создан с использованием TypeScript, их можно сгенерировать и связать в соответствующем package.json-файл с помощью свойства «типы» или «типы».

В качестве альтернативы (хотя я не тестировал этот подход) существующие комментарии JSDoc можно использовать для сгенерировать эти определения TypeScript.

Кроме того, сообщество TypeScript (часто вручную) создало отдельные определения Typescript, которые доступны в виде пакетов npm, называемых @types/name-of-the-package.

В вашем случае первый подход к созданию/генерации файла типизации и связыванию его с вашим package.json, вероятно, является лучшим подходом для достижения желаемого результата.

Кстати, если вы хотите проверить такой файл определений машинописного текста, нажмите Ctrl (в Windows) и щелкните метод JSON.parse. Это покажет вам соответствующий файл определений машинописного текста с именем lib.es5.d.ts (который встроен в vscode как часть языка JavaScript и поэтому не требует установки)

Потрясающий. Спасибо за подробное объяснение. Я попробую. Имеет смысл, так как я видел, что машинописный текст упоминается для подобных вещей, но не знал, как он интегрируется.

isaacgr 20.07.2019 19:29

Другие вопросы по теме