javascript - 悬停时如何让 VSCode 显示我的库函数参数

Question

我写了一个 JavaScript 库，我试图了解当用户在 VSCode 中将鼠标悬停在函数参数/定义上时如何显示它们（我在其他库中看到了这一点，我没有注意到它们有什么特别之处）。我确定它很简单，但我只是不知道我会怎么做。该项目的链接在这里：https ://github.com/isaacgr/jaysonic

我尝试在类定义周围添加 jsdoc 样式注释，但总的来说我不确定要尝试什么。如果有人能指出我正确的方向，我将不胜感激。

一个例子就是我在 JSON.parse 中看到的

标签： javascriptnpmvisual-studio-codejsdoc

Answer 1

Visual Studio Code 使用IntelliSense进行自动完成，就像你提到的那样，在 JavaScript 中它们主要基于 TypeScript 定义。如果项目已经使用 TypeScript 构建，则可以使用“typings”或“types”属性在相应的package.json 文件中生成和链接它们。

或者（我还没有测试过这种方法）现有的 JSDoc 注释可以用来生成这些 TypeScript Definitions。

此外，TypeScript 社区（通常是手动）创建了单独的 Typescript-Definitions，它们以 npm 包的形式提供，称为 @types/name-of-the-package。

在您的情况下，创建/生成类型文件并将其链接到您的 package.json 的第一种方法可能是实现所需结果的最佳方法。

顺便说一句，如果您想检查这样的打字稿定义文件，请按 Ctrl（在 Windows 上）并单击 JSON.parse 方法。这将向您显示名为 lib.es5.d.ts 的相应打字稿定义文件（它嵌入在 vscode 中，因为它是 JavaScript 语言的一部分，因此不需要安装）