ডকুমেন্ট জেএসডকে ফাংশন প্যারামিটারের কাঠামো তৈরি করে

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

( গুগল ক্লোজার সংকলক প্রকারের চেকিং , যা ভিত্তিক কিন্তু জেএসডোক থেকে ডাইভার্ট করা হয়েছিল তাও অনুমতি দেয় @param {{x:number,y:number}} point A "point-shaped" object.)