JSDoc कमेंटिंग स्टैंडर्ड
JavaScript में फंक्शन्स को डॉक्यूमेंट करने का मानक तरीका JSDoc फॉर्मेट है। यह विशेष टैग्स का उपयोग करके पैरामीटर्स, रिटर्न वैल्यू, और अन्य मेटाडेटा का वर्णन करता है।
मानक फॉर्मेट
/**
* दो नंबर जोड़ता है
* @param {Number} num1 - पहला नंबर
* @param {Number} num2 - दूसरा नंबर
* @return {Number} दोनों नंबरों का योग
*/
function sum(num1, num2) {
return num1 + num2;
}
सामान्य JSDoc टैग्स
| टैग | उद्देश्य | उदाहरण |
|---|---|---|
| @param | पैरामीटर का वर्णन | @param {string} name - उपयोगकर्ता का नाम |
| @returns / @return | रिटर्न वैल्यू का वर्णन | @returns {boolean} सफलता स्थिति |
| @throws | फेंके जा सकने वाले अपवाद | @throws {Error} अमान्य इनपुट पर |
| @example | उपयोग उदाहरण | @example sum(2, 3) // 5 |
| @deprecated | अप्रचलित चिह्नित करें | @deprecated v2.0 से उपयोग न करें |
| @see | संदर्भ लिंक | @see https://example.com |
| @since | संस्करण जब जोड़ा गया | @since 1.0.0 |
पूर्ण उदाहरण
/**
* उपयोगकर्ता प्रोफाइल प्राप्त करता है
* @param {string} userId - उपयोगकर्ता की विशिष्ट ID
* @param {Object} [options] - वैकल्पिक विकल्प
* @param {boolean} [options.includePosts=false] - पोस्ट शामिल करें
* @returns {Promise
टाइप एनोटेशन्स
सामान्य टाइप्स: string, number, boolean, Object, Array, Function, Promise, Date, RegExp, Element, Event, * (कोई भी)।
नोट: TypeScript का उपयोग करने वाले प्रोजेक्ट्स में, JSDoc के बजाय TypeScript टाइप एनोटेशन्स का उपयोग किया जाता है।
