Javascript 对象上的JSDoc';属性来描述函数的参数
如果我有一个对象(或者更准确地说是一个分配给节点中Javascript 对象上的JSDoc';属性来描述函数的参数,javascript,node.js,visual-studio-code,jsdoc,Javascript,Node.js,Visual Studio Code,Jsdoc,如果我有一个对象(或者更准确地说是一个分配给节点中模块.exports)的对象,并且该对象的属性可能由函数组成,我如何记录函数的参数和返回值 例如: module.exports = { /** * Adds two numbers together. * @param {number} first The first number * @param {number} second The second number * @return {numb
模块.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无法工作。注意:Number
和Number
都很好,我怀疑还有其他“类型”也不关心大小写敏感度。这实际上在VSCode中正常工作。我的问题是我的@param
类型没有正确的大小写(Object
工作,而Object
不工作),这意味着Intellisense无法工作。注意:Number
和Number
都可以,我怀疑还有其他“类型”也不关心区分大小写。您可能需要在问题中添加vscode
标记,因为它可能特定于该程序。这似乎是IDE的一个常见问题。还有一个问题:,尽管这更多的是关于资本化。另请参见,尽管这似乎表明它已在较新版本的VSCode中修复。谢谢。关于大写的链接让我找到了答案。您可能需要在问题中添加vscode
标记,因为它可能特定于该程序。这似乎是IDE的一个常见问题。还有一个问题:,尽管这更多的是关于资本化。另请参见,尽管这似乎表明它已在较新版本的VSCode中修复。谢谢。关于大写的链接让我找到了答案。亲爱的大卫,我尝试了@param{Object}obj
和@param{Object}obj
,在这两种情况下我都得到了(parameter)obj:any
。我是否需要在VSCode中设置更多内容?谢谢你的时间^^亲爱的大卫,我试过了@param{Object}obj
和@param{Object}obj
,在这两种情况下我都得到了(parameter)obj:any
。我是否需要在VSCode中设置更多内容?谢谢你抽出时间^^