繁体   English   中英

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

[英]JSDoc - Correct way to document a method which potentially returns any type?

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

在PHPdoc中,我将使用:

@return mixed

等效的JSDoc是什么?

您可以在JSDoc中使用星号

@returns {*}

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

@returns {String|Number|Boolean}

JSDoc文档介绍了有关类型表达式的信息

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

Closure Compiler文档上的链接页面显示

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

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

暂无
暂无

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM