JSDoc中的文档解构函数参数

Question

以前我总是将我的对象参数记录如下：

/**
 * Description of the function
 *
 * @param {Object} config - The configuration
 * @param {String} config.foo
 * @param {Boolean} [config.bar] - Optional value
 * @return {String}
 */
function doSomething (config = {}) {
  const { foo, bar } = config;
  console.log(foo, bar);
  // do something
}

但我不确定使用 desctructured 函数参数的最佳方法是什么。我只是忽略对象，以某种方式定义它还是记录它的最佳方式是什么？

/**
 * Description of the function
 *
 * @param {String} foo
 * @param {Boolean} [bar] - Optional value
 * @return {String}
 */
function doSomething ({ foo, bar } = {}) {
  console.log(foo, bar);
  // do something
}

我觉得我上面的方法并没有表明该函数需要一个 object 而不是两个不同的参数。

我能想到的另一种方法是使用@typedef，但这可能最终会变得一团糟（尤其是在具有许多方法的较大文件中）？

/**
 * @typedef {Object} doSomethingConfiguration
 * @property {String} foo
 * @property {Boolean} [bar] - Optional value
 */

/**
 * Description of the function
 *
 * @param {doSomethingConfiguration}
 * @return {String}
 */
function doSomething ({ foo, bar } = {}) {
  console.log(foo, bar);
  // do something
}

Answer 1

这就是它的意图，如documentation 中所述。

/**
 * My cool function.
 *
 * @param {Object} obj - An object.
 * @param {string} obj.prop1 - Property 1.
 * @param {string} obj.prop2 - Property 2.
 */
const fn = function ({prop1, prop2}) {
  // Do something with prop1 and prop2
}

所以，你的第一个例子是非常正确的。

另一个嵌套更深的例子：

/**
 * Nesting example.
 *
 * @param {object} param
 * @param {number} param.a - First value
 * @param {object} param.b - Wrapper
 * @param {number} param.b.c - Second value
 * @return {number} sum a and b
 */
const letters = ({a, b: {c}}) => a + c;

Answer 2

我个人用这个：

/**
* @param {{
  a: number
  b: number
}} param0
* @returns {number} The sum
*/
const func = ({ a, b }) => a + b;

只需在此处创建对象即可。

I also take advantage of TypeScript，并将可选的b 声明为b? 或b: number | undefined 作为JSDoc also allows unions

Answer 3

见JSDoc's "Documenting a parameter's properties"：

/**
 * Assign the project to an employee.
 * @param {Object} employee - The employee who is responsible for the project.
 * @param {string} employee.name - The name of the employee.
 * @param {string} employee.department - The employee's department.
 */
Project.prototype.assign = function(employee) {
    // ...
};

(Google Closure compiler type checking，基于但转自JSDoc，也允许@param {{x:number,y:number}} point A "point-shaped" object.)