有没有办法在 Angular 个项目中通过 intellisense 显示库中的函数注释？

Question

我有一个 Angular 6 应用程序，使用 Visual Studio 代码作为我的 IDE，我安装并导入了我制作的 JavaScript 库，以便我可以使用它在我的 angular 应用中。我的 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 应用程序中使用此功能时，VSCode 的智能提示如下：

greetings(name: string): string

我希望它显示函数的实际注释，但事实并非如此。有没有办法，通过 JSON 文件中的某些设置，通过库，通过 VSCode 等，我可以向用户显示我对库功能的评论？

注意：对于这种特殊情况，我的库正在导出函数，当我在我的 angular 项目中使用它们时，我直接导入它们，如：

import { greetings } from 'my-library';

谢谢

Answer 1

自动类型获取 (ATA) 为 package.json.

中引用的 npm 模块提取 npm 类型声明文件 (*.d.ts)

当您将鼠标悬停在文件中的文本上时，您会看到 VS Code 为您提供有关源代码中关键项目的信息。诸如变量、类和 Angular 装饰器之类的项目是您将获得此信息的几个示例。

检查此 link：https://code.visualstudio.com/docs/nodejs/angular-tutorial

Answer 2

我相信您仍然可以像以前一样在您的库中使用摘要，只是您需要删除定义类型周围的大括号。

/**
 * Send a custom greeting to a person.
 * @param string name - Name of person to greet
 * @return - Returns a custom greeting
 */

有没有办法在 Angular 个项目中通过 intellisense 显示库中的函数注释？

Is there a way to make function comments from a library show through intellisense in Angular projects?

javascript

angular

visual-studio-code

comments

javascript-intellisense