javascript - JSDoc 在对象的属性上描述函数的参数

标签 javascript node.js visual-studio-code jsdoc

如果我有一个对象(或更准确地说是分配给 Node 中的 module.exports 的对象)并且该对象的属性可能由函数组成,我如何记录函数的参数和返回值?

示例:

module.exports = {
    /**
     * Adds two numbers together.
     * @param {number} first The first number
     * @param {number} second The second number
     * @return {number} The sum of the two numbers
    */
    "add": function(first, second) {
        return first + second;
    }
}

这似乎不受支持(至少在 VSCode 中不受支持),并且我在 JSDoc 文档中找不到任何描述在这种情况下记录函数参数的方法(或仅针对普通对象)。 JSDoc 描述有效(由 VSCode 的 Intellisense 显示),但参数定义和返回定义无效。

有没有办法记录函数,以便它们显示在引用它们的对象中?

最佳答案

这实际上在 VSCode 中可以正常工作。我的问题是我的 @param 类型没有正确的大写(Object 可以工作,而 object 则不能),这意味着 Intellisense 无法工作。注意: Numbernumber 都可以,我怀疑还有其他“类型”也不关心大小写。

关于javascript - JSDoc 在对象的属性上描述函数的参数,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/41469904/

相关文章:

go - 为什么vscode在保存时删除golang源

javascript - 如何使用 Postman 中的预请求脚本运行另一个请求

javascript - 在父窗口中打开 URL

node.js - 返回 MongoDB 中具有不同字段和 1 个选择查询的整个文档

f# - 如何设置 Visual Studio 代码 launch.json 文件以调试 F#?

python - 在 Visual Studio Code 容器中安装 Python 库

javascript - 为什么 "undefined"在 Angular JS 中显示?

javascript - 解析对象的 JSON 数组 : undefined property

javascript - 为什么 req.body 对我来说总是未定义

javascript - 在 node.js 中使用 npm 包 Twitter 发布推​​文(不起作用)