对象数组如何注释

[luzhenzhen]

对象数组中对象的属性如何注释，格式应该是什么样子的？

[techird]

用 JSDoc @typedef 嘛：

/**
 * @typedef {{ name: string; level: number }} Person
 **/

/** @types {Person[]} */
const persons = [{
   { name: "集鹄大叔", level: 9999 },
   { name: "胡子大叔", level: 1 },
}];

[luzhenzhen]

那作为函数参数的时候该怎么注释呢？比如：

/**
 * 数字数组参数注释
 *
 * @param {Array.<number>} nums 数字数组
 */
function showNums(nums) {
    // ...
}

/**
 * 对象参数注释
 *
 * @param {Object} user 用户
 * @param {string} user.name 用户姓名
 * @param {number} user.age 用户年龄
 */
function showUser(user) {
    // ...
}

/**
 * 对象数组参数注释
 *
 * @param {Array.<Object>} users 用户数组
 * @param {string} users[i].name 用户姓名
 * @param {number} users[i].age 用户年龄
 */
function showUsers(users) {
    // ...
}

上面的第三个函数注释格式肯定不对，应该怎么去写这种注释呢？

[luzhenzhen]

emm...
查阅了一些资料，答案如下：

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

参考资料：
http://usejsdoc.org/tags-param.html