JSDocで非構造化関数パラメーターを文書化する

以前は、オブジェクトパラメータを次のように常に文書化していました。

/**
 * 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
}

上記の私のアプローチでは、関数がobject2つの異なるパラメーターではなく1つのパラメーターを期待していることが明確になっていないように感じます。

私が考えることができる別の方法はを使用すること@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
}

ドキュメントで説明されているように、これは意図された方法です。

/**
 * My cool function.
 *
 * @param {Object} obj - An object.
 * @param {string} obj.prop1 - Property 1.
 * @param {string} obj.prop2 - Property 2.
 */
var 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
 */
letters = ({a, b: {c}}) => a + c;

私は個人的にこれを使用します：

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

そこにオブジェクトを作成するだけです。

私もTypeScriptを利用しており、JSDocでもユニオンを許可しているのでb、b?またはb: number | undefinedとして、obtionalを宣言します。

JSDocの「パラメータのプロパティの文書化」を参照してください。

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

（JSDocに基づいているが、JSDocから転用された、Google Closureコンパイラの型チェックも可能です@param {{x:number,y:number}} point A "point-shaped" object.）