在 JSDoc 中描述对象数组

Question

我有一个接受对象数组的函数。
看起来像这样。

myAwesomeFunction([
    {
        name: 'someName',
        next: false,
        test: 'test'
    },
    {
        name: 'nameTwo',
        next: true
    }
]);

到目前为止我的 JSDoc 看起来像这样

/**
 * My description
 * @param {Array.<Object>}
 */

但是我如何描述对象的属性、类型和描述，以及它们是否是对象的可选内容？

谢谢。

Answer 1

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) {
    // ...
};
/**

Answer 2

使用typedef

/**
 * @typedef AwesomeObject
 * @type {Object}
 * @property {string} name
 * @property {boolean} next
 * @property {string} test
 */

/**
 * @param {Array.<AwesomeObject>} awesomeObjects Awesome objects.
 */
myAwesomeFunction(awesomeObjects) { ... }

在 JSDoc 中描述对象数组

Describing an array of objects in JSDoc

javascript

jsdoc

jsdoc3

使用typedef