Question

如果我有一个对象（或者更准确地说是在节点中分配给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的智能感知显示），但参数定义和返回定义不是。

有没有办法记录功能，以便它们显示在引用它们的对象中？

Answer 1

这实际上在VSCode中正常工作。我的问题是我的@param类型没有正确的大小写（Object有效，而object没有），这意味着Intellisense无法正常工作。注意：Number和number都很好，我怀疑还有其他“类型”也不关心区分大小写。

JSDoc在一个对象的属性上描述一个函数的参数

1 个答案: