दस्तावेज़ JSDoc में फ़ंक्शन पैरामीटर को नष्ट कर दिया

Question 1

पहले मैंने हमेशा अपने ऑब्जेक्ट पैरामीटर को निम्नानुसार प्रलेखित किया है:

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

लेकिन मैं अनिश्चित हूं कि डिसट्रक्टेड फंक्शन पैरामीटर के साथ सबसे अच्छा तरीका क्या है। क्या मैं सिर्फ ऑब्जेक्ट को अनदेखा करता हूं, इसे किसी तरह परिभाषित करता हूं या इसे दस्तावेज करने का सबसे अच्छा तरीका क्या है?

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

Question 2

यह इस तरह से है, जैसा कि प्रलेखन में वर्णित है ।

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

Question 3

मैं व्यक्तिगत रूप से इसका उपयोग करता हूं:

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

बस वहीं ऑब्जेक्ट बनाएं।

मैं भी टाइपप्रति का लाभ लेने के लिए, और obtional घोषणा करेंगे bके रूप में b?या b: number | undefinedके रूप में JSDoc भी यूनियनों की अनुमति देता है

Question 4

देखें 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 क्लोजर कंपाइलर प्रकार की जाँच , जो JSDoc से डायवर्ट की गई थी, पर आधारित है @param {{x:number,y:number}} point A "point-shaped" object.) भी अनुमति देता है )