悬停时如何获取VSCode以显示我的库函数参数

Question

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

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

An example would be what I see with JSON.parse

Answer 1

Visual Studio Code使用IntelliSense进行自动填充，就像您提到的那样，在JavaScript中，它们主要基于TypeScript定义。如果已经使用TypeScript构建了项目，则可以使用“类型”或“类型”属性生成并链接到相应的package.json-file中。

或者（尽管我还没有测试这种方法）现有的JSDoc注释可以用于generate these TypeScript Definitions。

TypeScript社区还（通常是手动）创建了单独的Typescript-Definitions，它们可作为名为@ types / the-package-the-package的npm软件包获得。

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

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