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

如何将对象数组记录为JSDoc中的参数?

叶文博
2023-03-14

我有一个数组,看起来像这样:

[{
    "name": "c917379",
    "email": "jim@bmw.de"

},
{
    "name": "c917389",
    "email": "jane@bmw.de"
}]

它是一个任意长度的数组,带有许多重复字段(为了清楚起见,我将其减少为两个字段)。这被传递到JavaScript方法中。

/**
 * @param {?}  data
 */
update:  function(data) {...}

我想知道你将如何在JSDoc中记录这一点。例如,你将如何记录问号所在的类型?

共有3个答案

姬凡
2023-03-14

由于您的对象内容没有本质上的“特殊”,我相信您只需将其声明为:

@param {Object[]} data

另一种方法是为您的“类”声明一个“正确”的构造函数,然后将Object替换为该函数名称。

这种封装也可能有助于您代码的其他部分;-)

吕永寿
2023-03-14

我刚刚找到了问题的答案:

它看起来是这样的:

/**
 *
 * @param {{name:string, email:string}[]}  
 *
 */
任绪
2023-03-14

在JSDoc中,有一个数组的示例,其成员类型为MyClass。看起来是这样的:

@param {Array.<MyClass>}

所以你也可以这样做:

@param {Array.<Object>}

这也是有道理的:

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

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

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

  • 问题内容: 想要改善这篇文章吗? 提供此问题的详细答案,包括引文和答案正确的解释。答案不够详细的答案可能会被编辑或删除。 JavaScript中的对象是一个奇怪的疣-在大多数情况下,它的行为就像一个数组,但实际上不是数组对象。因为它是真正的完全是另一回事,它没有从有用的功能类似,,,和。 使用一个简单的for循环从arguments对象构造新数组非常容易。例如,此函数对其参数进行排序: 但是,仅获

  • 有下一个例子: 知道locale属性包含的是来自数据库的dictionary对象,我如何用JSDoc记录其内部属性? 目前,我正在考虑为我的区域设置对象键入typedef,那么我可以将locale属性设置为我定义的类型的数组吗?这样做对吗?

  • 我有以下练习: 编写一个名为createListOfObjects的函数,该函数接受 包含名字和姓氏以及返回值的字符串数组 一个对象数组,每个对象都具有属性 和以及名字和姓氏值 对应值* var namesList=['Cameron Betts','Shana Lopez','Angela li']* createListOfObjects(名称列表) = 到目前为止,我的解决方案是: 但它返回