在前端开发中，我们经常需要传递和处理对象数组。使用 JSDoc 可以方便地为函数和方法定义参数和返回值的类型，以提高代码可读性和维护性。本文将介绍如何在 JSDoc 中指定对象数组作为参数或返回值。
在参数中指定对象数组
要在参数中指定对象数组，可以使用 Array.<Object> 或 {Object[]} 对象数组类型标记。
例如，在以下示例代码中，printUsers 函数接受一个名为 users 的对象数组，并打印每个用户的名称和年龄：
---
- ------
- ------ ---------------- ----- - ------
--
-------- ----------------- -
------------------ -- -
-------------------------- --------------
---
-
----- ----- - -
- ----- -------- ---- -- --
- ----- ------ ---- -- -
--
------------------在返回值中指定对象数组
要在返回值中指定对象数组，可以在函数声明中使用 @returns 标记，并指定返回值类型为 Array.<Object> 或 {Object[]}。
例如，在以下示例代码中，getUsers 函数返回一个名为 users 的对象数组：
---
- ------
- -------- ---------------- ------
--
-------- ---------- -
------ -
- ----- -------- ---- -- --
- ----- ------ ---- -- -
--
-
----- ----- - -----------
-------------------指定对象数组中的属性类型
如果要指定对象数组中的属性类型，可以使用以下格式：
--- - ------ -------- ------ ------ --------- ----- - ---- -- -------- ----------------- - -- --- -
例如，在以下示例代码中，printUsers 函数接受一个名为 users 的对象数组，并假设每个用户对象具有 name 和 age 属性：
---
- ------
- ------ ------- ------- ---- ---------- ----- - ------
--
-------- ----------------- -
------------------ -- -
-------------------------- --------------
---
-
----- ----- - -
- ----- -------- ---- -- --
- ----- ------ ---- -- -
--
------------------总结
在 JSDoc 中指定对象数组作为参数或返回值是一种提高代码可读性和维护性的有效方式。通过本文介绍的方法，我们可以清晰地定义函数和方法的输入输出，以及对象数组中的属性类型。
来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/24043