Javascript 在JSDoc中描述对象数组
我有一个函数,它接受一个对象数组。Javascript 在JSDoc中描述对象数组,javascript,jsdoc,jsdoc3,Javascript,Jsdoc,Jsdoc3,我有一个函数,它接受一个对象数组。 看起来像这样 myAwesomeFunction([ { name: 'someName', next: false, test: 'test' }, { name: 'nameTwo', next: true } ]); 到目前为止,我的JSDoc看起来像这样 /** * My description * @param {Array.<
看起来像这样
myAwesomeFunction([
{
name: 'someName',
next: false,
test: 'test'
},
{
name: 'nameTwo',
next: true
}
]);
到目前为止,我的JSDoc看起来像这样
/**
* My description
* @param {Array.<Object>}
*/
/**
*我的描述
*@param{Array.}
*/
但是如何描述对象属性、类型和描述,以及它们是否是对象的可选项
谢谢。
使用
/**
*@typedef AwesomeObject
*@type{Object}
*@property{string}name
*@property{boolean}next
*@property{string}测试
*/
/**
*@param{Array.}awesomeObjects awesomeObjects。
*/
myAwesomeFunction(awesomeObjects){…}
/**
* 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) {
// ...
};
/**
/**
* @typedef AwesomeObject
* @type {Object}
* @property {string} name
* @property {boolean} next
* @property {string} test
*/
/**
* @param {Array.<AwesomeObject>} awesomeObjects Awesome objects.
*/
myAwesomeFunction(awesomeObjects) { ... }