Javascript文档:返回null或type
我有一个js类函数,它可以返回字符串或未定义的Javascript文档:返回null或type,javascript,jsdoc,Javascript,Jsdoc,我有一个js类函数,它可以返回字符串或未定义的。现在我想在函数的文档中插入return语句 /** * Test documentation. * * @param {(String|Number)} value - A String or a number containing a number. * * @returns {(String|undefined)} - Returns a String or undefined.
。现在我想在函数的文档中插入return
语句
/**
* Test documentation.
*
* @param {(String|Number)} value - A String or a number containing a number.
*
* @returns {(String|undefined)} - Returns a String or undefined.
*/
nullOrString(value) {
// ...
}
但是当我调用函数时,return
语句的文档只返回String
,而不返回(String | undefined)
。
我还尝试了使用null
而不是undefined
,因为默认情况下所有函数都会返回undefined
,而不使用return
语句
那么,如何在文档中添加返回的未定义
或空
编辑:
添加另一个测试函数。
请注意,这些示例都是测试函数,不一定有意义
/**
* Test documentation function.
*
* @param {(String|Number)} input - Input String.
*
* @returns {null|undefined} - Returns null when input is numeric, otherwise returns undefined.
*/
undefinedOrNull(input) {
if (!isNaN(parseFloat(input))) return null;
return undefined;
}
Visual studio代码返回:
undefinedOrNull(输入:字符串|编号):null
输入字符串
测试文档功能
@返回--当输入为数字时返回null,否则返回未定义。那里的内容应该可以正常工作
/**
*
*@param值
*@returns{string | undefined}
*/
函数nullOrString(值){
// ...
}
不需要括号,但这不重要,我认为您需要的是小写字符串,而不是字符串
你那里的东西应该可以用
/**
*
*@param值
*@returns{string | undefined}
*/
函数nullOrString(值){
// ...
}
不需要括号,但这不重要,我认为您需要的是小写字符串,而不是字符串
您所拥有的是正确的(除了没有理由在字符串|未定义的周围使用()
)。您看到什么表明返回类型不是您为其定义的类型?JSDoc具体告诉您什么(复制和粘贴)?另外,函数的内容是什么样的?有些工具足够聪明,可以细化类型,尽管对于显式列出的类型,我希望这样的工具会在函数定义上给出警告,而不是在调用它的位置。因此,请确保实际返回null。也许您总是返回字符串?(旁注:nullOrString
是一个奇怪的名称,用于给您提供未定义的或字符串…;-)编辑的问题。您所拥有的是正确的(除了在字符串|未定义的()
周围没有任何原因)。您看到什么表明返回类型不是您为其定义的类型?JSDoc具体告诉您什么(复制和粘贴)?另外,函数的内容是什么样的?有些工具足够聪明,可以细化类型,尽管对于显式列出的类型,我希望这样的工具会在函数定义上给出警告,而不是在调用它的位置。因此,请确保实际返回null。可能您总是返回字符串?(旁注:nullOrString
是一个奇怪的名称,用于给您提供undefined
或字符串…;-)问题编辑。Visual Studio代码说:nullOrString(value:any):string@returnsVisual Studio代码说:nullOrString(value:any):string@returns