JSDoc - 记录可能返回任何类型的方法的正确方法?

时间:2014-12-08 18:15:48

标签: javascript jsdoc

我有一个实用程序函数,它从数组中返回一个值。但是,您的数组显然可能包含任何类型的元素,因此如何记录返回类型是否混合?

在PHPdoc中我会使用:

@return mixed

什么是JSDoc等价物?

2 个答案:

答案 0 :(得分:6)

您可以在JSDoc中使用星号

@returns {*}

或者,如果你知道所有可能的类型,你可以通过管道将它们分开

@returns {String|Number|Boolean}

答案 1 :(得分:0)

JSDoc文档说明了type expressions

  

您可以使用任何Google Closure Compiler类型表达式...

linked page on the Closure Compiler docs说:

  

ALL类型{*}表示变量可以采用任何类型。

因此,您可以将@returns {*}用于可以返回任何类型的函数。