JSDoc'ta bozulmuş işlev parametresini belgeleyin

Daha önce nesne parametrelerimi her zaman aşağıdaki gibi belgelemiştim:

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

Ancak, yapılandırılmış fonksiyon parametresiyle en iyi yaklaşımın ne olduğundan emin değilim. Nesneyi görmezden mi geliyor, bir şekilde tanımlıyor muyum yoksa onu belgelemenin en iyi yolu nedir?

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

Yukarıdaki yaklaşımımın, işlevin objectiki farklı parametre beklemediğini açıkça belirtmediğini hissediyorum .

Düşünebileceğim başka bir yol kullanmak @typedefolabilir, ancak bu büyük bir karmaşa haline gelebilir (özellikle birçok yöntem içeren daha büyük bir dosyada)?

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

Dokümantasyonda açıklandığı gibi bu şekilde tasarlanmaktadır .

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

Yani, ilk örneğiniz oldukça doğru.

Daha derin yuvalama ile başka bir örnek:

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

Ben şahsen bunu kullanıyorum:

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

Hemen orada nesneyi yaratın.

Ayrıca typescript yararlanmak ve obtional ilan edeceklerini bolarak b?ya b: number | undefinedkadar JSDoc da sendikalara izin verir

JSDoc'un "Bir parametrenin özelliklerini belgeleme" bölümüne bakın :

/**
 * 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'a dayanan ancak ondan yönlendirilen Google Closure derleyici türü denetimi de izin verir @param {{x:number,y:number}} point A "point-shaped" object.)