জেএসডকে প্যারামিটার বা রিটার্ন মান হিসাবে কী কী অবজেক্টের অ্যারে নির্দিষ্ট করবেন?

Question

জেএসডোকে, সেরা ডকুমেন্টেশনগুলি নীচের ব্যবহারের জন্য শোগুলি সন্ধান করতে পারি যদি আপনার কাছে কোনও নির্দিষ্ট ধরণের অ্যারে থাকে (যেমন স্ট্রিংগুলির অ্যারে):

/**
 * @param {Array.<string>} myStrings All my awesome strings
 */
 function blah(myStrings){
     //stuff here...
 }

আপনি কীভাবে নীচের প্রশ্ন চিহ্নগুলিকে অবজেক্টগুলির একটি অ্যারে নির্দিষ্ট করবেন?

/**
 * @param {???????} myObjects All of my equally awesome objects
 */
 function blah(myObjects){
     //stuff here...
 }

Comments

— জেএসডোক

Answer 1

আপনি জেএসডোক বলতে যা বোঝাতে চেয়েছেন সে সম্পর্কে আপনার আরও নির্দিষ্ট হওয়া উচিত - এটি একটি জেনেরিক শব্দ যা জাভাস্ক্রিপ্টের জন্য সমস্ত জাভডোক স্টাইলের ডকুমেন্টেশন সরঞ্জামগুলিকে অনেক বেশি কভার করে।

আপনি যে স্ট্রিংয়ের অ্যারে ব্যবহার করেছেন তার সিনট্যাক্সটি Google ক্লোজার কমপাইলার দ্বারা সমর্থিত মত দেখাচ্ছে ।

এটি ব্যবহার করে, অবজেক্টগুলির একটি অ্যারেটি হ'ল:

/**
 * @param {Array.<Object>} myObjects
 */

বা কেবল যে কোনও কিছুর অ্যারে - এটি সমস্ত ডক সরঞ্জামের সাথে কাজ করা উচিত:

/**
 * @param {Array} myArray
 */

jsdoc-toolkit , JSDoc 3 , এবং JSDuck অবজেক্টের অ্যারে বোঝাতে নিম্নলিখিত সিনট্যাক্সটিকে সমর্থন করে:

/**
 * @param {Object[]} myArray
 */

---

সম্পাদনা

আপনি কীগুলি এবং ভেরিয়েবল ধরণের মানগুলি জানেন তা আপনি করতে পারেন:

/**
 * @param {Array.<{myNumber: Number, myString: String, myArray: Array}>} myObjects
 */

অথবা

/**
 * @param {{myNumber: Number, myString: String, myArray: Array}[]} myObjects
 */

Comments

দ্য . স্বীকৃতি এখন অবচয় করা হয়েছে এবং এর সমর্থন পরে বাদ দেওয়া উচিত। বর্তমানের সঠিক সংস্করণটি {Array<Object>}। শুধু এই পোস্টটি টু ডেট রাখার জন্য।

— কেনি 806

জেএসডোক 3 এর সাথে আপনি কীভাবে স্ট্রিং অ্যারের অ্যারে ডক করবেন? পুরানো বাক্য Array.<string[]>

— বাক্সে

@ কেনি 806 অবনতি হয়েছে? একটি রেফারেন্স ডকুমেন্ট দয়া করে?

— উইল

@ উইল্ট: জেএসডোক ডকুমেন্টেশনটি কোণ বন্ধনীগুলির আগে বিন্দুর সাথে বিরোধী ।

— ড্যান ড্যাসক্লেস্কু

এই উত্তরটি কীভাবে সেই অ্যারেতে থাকা বস্তুর কীগুলি ঘোষণা করতে হবে এবং কী কীভাবে নির্দিষ্ট কীগুলির সাথে একটি রিটার্ন টাইপ হিসাবে ঘোষণা করবেন তা ব্যাখ্যা করে না। এই উত্তর দেয়।

— ড্যান ড্যাসক্লেস্কু