如何在JsDoc中返回void?
有没有一种特定的方式来声明一个方法或函数在JsDoc中返回void? 目前我认为void
是默认返回值,其他返回值必须具体提供:
/** * @return {Integer} The identifier for ... */
我不相信你必须从JsDoc中的一组types中进行select…你可以使用任何你想要的types名称(大括号指出它是一个types),所以你可以简单地做:
@return {Void}
虽然,这可能是更正确的JavaScript:
@return {undefined}
closures编译器
根据Google的Closure Compiler的文档,如果没有任何东西被返回,@return注释应该被省略。
如果没有返回值,则不要使用@return标记。
来源: https : //developers.google.com/closure/compiler/docs/js-for-compiler#tags
jsdoc的工具包
但是,进一步的文档还指出,returnType和returnDescription是可选参数。
returnType – 可选:返回值的types。
returnDescription – 可选:任何附加描述。
来源: https : //code.google.com/p/jsdoc-toolkit/wiki/TagReturns
概要
您可以省略返回注释或者不包含任何参数。
查看ESlint文档,他们使用@returns {void}
资料来源: http : //eslint.org/docs/rules/valid-jsdoc
因为我需要为每个函数提供@returns
来通过testing,以便为某些项目推送代码,在我的情况下这是必需的。
如果你需要大声说没有什么东西被返回,你可以在自由forms的说明中说 。 这对澄清用户可能期望返回某些内容的情况很有用。 当然,函数和参数的正确命名应该使预期的返回types变得明显,但并不总是可能的。
/** * This is a funny function. Returns nothing. * @param {string} a joke. */ var funny = function (joke) { console.log(joke); };