【问题标题】:How to get VSCode to show my libraries function arguments when hovered悬停时如何让 VSCode 显示我的库函数参数
【发布时间】:2019-07-20 23:58:27
【问题描述】:

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

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

An example would be what I see with JSON.parse

【问题讨论】:

    标签: javascript npm visual-studio-code jsdoc


    【解决方案1】:

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

    或者(我还没有测试过这种方法)现有的 JSDoc cmets 可以用于generate these TypeScript Definitions。

    TypeScript 社区还(通常手动)创建了单独的 Typescript-Definitions,它们可作为称为 @types/name-of-the-package 的 npm 包提供。

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

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

    【讨论】:

    • 太棒了。感谢您的详细解释。我会试试这个。有道理,因为我看到类似这样的东西提到了打字稿,但不知道它是如何集成的。
    猜你喜欢
    • 2013-12-31
    • 1970-01-01
    • 2019-03-06
    • 1970-01-01
    • 2015-12-11
    • 2022-06-13
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多