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

Question

我有一个实用函数，它从你的数组中返回一个值。但是，你的数组显然可以包含任何类型的元素，那么我该如何记录返回类型为混合类型？

在PHPdoc中，我会使用：

@return mixed

JSDoc 的中文对应是什么？

- BadHorsie

Answer 1

你可以在 JSDoc 中使用星号

@returns {*}

或者，如果您知道所有可能的类型，可以用竖线分隔它们。

@returns {String|Number|Boolean}

- paulitto

Answer 2

JSDoc文档关于类型表达式的说明如下：

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

Closure Compiler文档上的链接页面说：

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

因此，您可以在函数中使用@returns {*}来返回任何类型。

- apsillers