如何在JsDoc中返回void？

Question

是否有指定的方法来声明方法或函数在JsDoc中返回void？目前我相信void是默认的返回值，并且必须专门提供其他返回值：

/**
 * @return {Integer} The identifier for ...
 */

Answer 1

Closure Compiler

根据Google Closure Compiler的文档，如果没有返回任何内容，则应省略@return注释。

  

如果没有返回值，请不要使用@return标记。

来源： https://developers.google.com/closure/compiler/docs/js-for-compiler#tags

jsdoc的工具包

然而，进一步的文档还指出returnType和returnDescription是可选参数。

  

returnType - 可选：返回值的类型。

     

returnDescription - 可选：任何其他说明。

来源： https://code.google.com/p/jsdoc-toolkit/wiki/TagReturns

摘要

您可以省略返回注释，也可以不带任何参数包含它。

Answer 2

我不相信你必须在JsDoc中选择一组类型...你可以使用你想要的任何类型名称（花括号表示它是一种类型），所以你可以简单地做：

@return {Void}

虽然这对JavaScript来说可能更正确：

@return {undefined}

Answer 3

查看他们使用的ESlint文档 @returns {void}

来源：http://eslint.org/docs/rules/valid-jsdoc

由于我需要为每个函数提供@returns以传递测试以推送某些项目的代码，因此在我的情况下这是必需的。

Answer 4

如果您需要大声说不返回任何内容，您可以在自由格式说明中说 。这有助于阐明用户可能希望返回某些内容的情况。当然正确命名函数和参数应该单独使预期的返回类型明显，但可能并不总是可能。

/**
 * This is a funny function. Returns nothing.
 * @param {string} a joke.
 */
var funny = function (joke) {
  console.log(joke);
};