Есть ли способ заставить VSCode отображать дополнительную информацию intellisense о функциях JavaScript из их строк комментариев?

#javascript #visual-studio-code #intellisense

#javascript #visual-studio-code #intellisense

Вопрос:

Visual Studio Code обеспечивает отображение полезной информации о функции при наведении курсора мыши в модуле JavaScript, например, так:

введите описание изображения здесь

Есть ли способ заставить его также отображать строку комментария над функцией, чтобы можно было отображать дополнительную информацию о функции, например, примеры того, как использовать функцию?

введите описание изображения здесь

Я помню, что это было возможно, например, в NetBeans с PHPDoc.

Ответ №1:

Используйте формат JS-Doc. Тогда это должно сработать. https://jsdoc.app /

 /**
 * Some comment
 */
export const replaceAll = (text: string, search: string, replace: string) => {
    return text.split(search).join(replace);
};
  

Комментарии:

1. Отлично работает «из коробки», без установки. Даже многострочные комментарии отображаются красиво. Спасибо.

2. Работает в VSCode без добавления каких-либо расширений, спасибо! Просто отформатируйте свой комментарий следующим образом: /** Comment */