javascript - JsDoc中如何返回void？

Question

在JsDoc中有没有规定方法或函数声明返回void的方式？目前我认为void是默认的返回值，其他返回值必须具体提供:

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

Answer 1

闭包编译器

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

If there is no return value, do not use a @return tag.

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

jsdoc-工具包

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

returnType - Optional: the type of the return value.

returnDescription - Optional: any additional description.

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

总结

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