javascript - 有没有办法在 Angular 项目中通过智能感知从库中显示函数注释?

标签 javascript angular visual-studio-code comments javascript-intellisense

我有一个 Angular 6 应用程序,使用 Visual Studio Code 作为我的 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';

谢谢

最佳答案

自动类型获取 (ATA) 会提取 package.json 中引用的 npm 模块的 npm 类型声明文件 (*.d.ts)。

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

检查此链接:https://code.visualstudio.com/docs/nodejs/angular-tutorial

关于javascript - 有没有办法在 Angular 项目中通过智能感知从库中显示函数注释?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/51064630/

相关文章:

visual-studio-code - vscode : Is it possible to show an image inside a text buffer?

javascript - 如何在 VS Code 中使用 d.ts 文件进行智能感知,类似于 NPM 方法

javascript - 当我在 chrome 的 input type = search 元素上单击 X 时,是否会触发任何事件?

javascript - TypeScript 启动一个空接口(interface)对象

来自父类的Angular2 EventEmitter

angular - SimpleMDE 与 Angular 6 获取组件中编辑器的引用

javascript - 如何从列表中过滤数据并以 Angular 从数据中删除现有房间

amazon-web-services - 如何使用 SFTP 中的 pem 文件将 EC2 实例与 VSCode Directy 连接

javascript - Javascript 测试用例中的虚假字符 : all breaks

javascript - 页面刷新 jsp 后选择框选项保持选中状态