描述JSDoc中的对象数组
Describing an array of objects in JSDoc
我有一个函数,它接受一个对象数组。
是这样的
myAwesomeFunction([
{
name: 'someName',
next: false,
test: 'test'
},
{
name: 'nameTwo',
next: true
}
]);
到目前为止,我的JSDoc看起来像这样
/**
* My description
* @param {Array.<Object>}
*/
但是我如何描述对象的属性、类型和描述,以及它们是否为对象的可选?
谢谢。
JSDoc @param documentation
/**
* Assign the project to a list of employees.
* @param {Object[]} employees - The employees who are responsible for the project.
* @param {string} employees[].name - The name of an employee.
* @param {string} employees[].department - The employee's department.
*/
Project.prototype.assign = function(employees) {
// ...
};
/**
Using typepedef
/**
* @typedef AwesomeObject
* @type {Object}
* @property {string} name
* @property {boolean} next
* @property {string} test
*/
/**
* @param {Array.<AwesomeObject>} awesomeObjects Awesome objects.
*/
myAwesomeFunction(awesomeObjects) { ... }
相关文章:
- Javascript(Angular)从一个对象数组到第二个数组查找值
- 在Javascript中转换对象数组
- 在JavaScript中通过索引从对象数组中获取值
- Backbone虹吸以获取对象数组
- 如何在DataTables 2.1中迭代对象数组
- Javascript-根据赋值顺序,按键合并对象数组
- 将事件附加到对象/数组
- jQuery$.inArray()总是返回-1和一个对象数组
- javascript处理一个对象数组以获得一个新的对象数组
- javascript在数组中获取对象数组中键的所有不同值
- 在对象数组中查找多个值的d3范围
- Undercore.js获取对象数组中键对象的值
- 在mongoose中使用正则表达式在对象数组中进行查询搜索
- 如何通过json对象数组为嵌套对象赋值
- 如何循环通过2个对象数组并通过匹配id进行合并
- 为对象数组创建列表项
- 如何使用javascript合并两个对象数组
- JSON到对象数组,并向每个对象添加项
- JavaScript:从对象数组中获取唯一值及其计数
- 按不同项目对对象数组进行排序