Есть ли способ сделать комментарии к функциям из библиотеки, показанной через intellisense в проектах Angular? - PullRequest
Новая
       23

Есть ли способ сделать комментарии к функциям из библиотеки, показанной через intellisense в проектах Angular?

0 голосов
/ 27 июня 2018

У меня есть приложение Angular 6, использующее код Visual Studio в качестве моей IDE, и я установил и импортировал созданную мной библиотеку JavaScript, чтобы использовать ее в своем угловом приложении. Моя библиотека JS имеет функции и классы, все со стандартными комментариями JavaScript, такими как: 

/**
 * Send a custom greeting to a person.
 * @param {string} name - Name of person to greet
 * @return {string} Return a custom greeting
 */
 export function greetings(name) {
     return 'Hello, ' + name;
 }

Когда я пытаюсь использовать эту функцию в своем приложении Angular, intellisense VSCode говорит следующее: 

greetings(name: string): string

Я ожидал, что он покажет фактический комментарий для функции, но это не так. Есть ли способ, через какую-то настройку в файле JSON, через библиотеку, через VSCode и т. Д., Чтобы я мог отобразить пользователю свой комментарий к функциям моей библиотеки?

ПРИМЕЧАНИЕ : в этом конкретном случае моя библиотека экспортирует функции, и когда я использую их в своем угловом проекте, я импортирую их напрямую, как: 

import { greetings } from 'my-library';

Спасибо

1 Ответ

0 голосов
/ 27 июня 2018

Автоматическое получение типа (ATA) извлекает файлы объявления типа npm (* .d.ts) для модулей npm, указанных в package.json.

Когда вы наведете указатель мыши на текст в файле, вы увидите, что VS Code предоставляет вам информацию о ключевых элементах вашего исходного кода. Такие элементы, как переменные, классы и угловые декораторы - вот несколько примеров, где вам будет представлена ​​эта информация.

Проверьте эту ссылку: https://code.visualstudio.com/docs/nodejs/angular-tutorial

...