พารามิเตอร์ฟังก์ชันทำลายโครงสร้างเอกสารใน 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
}

ฉันรู้สึกว่าแนวทางของฉันข้างต้นไม่ได้ทำให้ชัดเจนว่าฟังก์ชั่นคาดหวัง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
}

นี่คือวิธีที่มันตั้งใจที่อธิบายไว้ในเอกสาร

/**
 * 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และจะประกาศ obtional bเป็นb?หรือb: number | undefinedเนื่องจากJSDoc อนุญาตให้มีสหภาพแรงงานด้วย

ดู"การบันทึกคุณสมบัติของพารามิเตอร์" ของ 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) {
    // ...
};

( การตรวจสอบประเภทคอมไพเลอร์ Google Closureซึ่งขึ้นอยู่กับ แต่เบี่ยงเบนจาก JSDoc ก็อนุญาตเช่นกัน@param {{x:number,y:number}} point A "point-shaped" object.)