当前位置: 首页 > 知识库问答 >
问题:

JSDoc如何记录数组数组和布尔或其他类型的返回?

秦经义
2023-03-14

我有一个函数返回这样的数组:[[true, true], true]其中索引0是布尔数组,其次是布尔数组。如何以JSDoc返回类型记录此内容。

我试过:@返回{[boolean[],boolean]},它产生“无法解析…”。。。“无效的类型表达式..”错误

共有1个答案

萧修永
2023-03-14

您有复杂的类型要返回,也许@typedef将是设置返回类型的更好选择。但是,如果您想保持原样,以下内容应该适合您...

@return {Array<Array<Boolean>, Boolean>}
 类似资料:
  • 我有一个以对象数组作为参数的函数,并希望使用JSDOC来描述参数(包括数组中对象的属性),如本例所示: 其中过滤器如下所示: 如何在jsdoc3中记录属性id和值?

  • 给定以下代码,如何使用最新的JSDoc正确记录它? 我尝试过这个: 显然这不起作用,JSDoc留档提到的只是如何记录去结构化对象参数,而不是去结构化数组参数。

  • 我有一个数组,看起来像这样: 它是一个任意长度的数组,带有许多重复字段(为了清楚起见,我将其减少为两个字段)。这被传递到JavaScript方法中。 我想知道你将如何在JSDoc中记录这一点。例如,你将如何记录问号所在的类型?

  • 当参数类型可以混合时,如何使用JSDoc在JavaScript中记录方法? 我有一个对话框对象的方法,我可以显示HTML或我自己的可视对象。JSDoc方法如下所示: 因为JS不允许方法重载,所以我需要创建这些类型的方法,其中方法中的参数可以是两种不同的类型。有没有办法在JSDoc中记录这一点,或者JSDoc只能让你记录一种类型的参数? 另外,您将如何记录类型的参数?也就是说,传入的对象不是类型。准

  • 问题内容: NumPy“结构化数组”,“记录数组”和“ recarray”之间的区别是什么? 该NumPy的文档 暗示,前两个是相同的:如果是这样,这是该对象的首选术语? 同样的文件说,(在页面的底部):你可以找到关于recarrays和结构化阵列(包括两者之间的区别)一些更多的信息在这里。是否有对此差异的简单解释? 问题答案: 记录/记录数组在 https://github.com/numpy/

  • 我有一个返回构造函数的javascript函数(见下面的代码示例)。我该如何用jsdoc的@returns标记来记录这一点。执行@returns{MyConstructor}似乎不正确,因为这意味着我返回的是“MyConstructor”的实例,而不是构造函数本身,对吗?