JavaScript में Comments क्या हैं? प्रकार , उपयोग

JavaScript में Comments

कोड को बेहतर तरीके से समझने और डॉक्यूमेंट करने का पूरा गाइड

JavaScript Comments क्या हैं?

JavaScript comments वे टेक्स्ट लाइन्स हैं जो प्रोग्राम के कोड में लिखे जाते हैं लेकिन JavaScript इंजन द्वारा एक्जीक्यूट नहीं किए जाते। ये केवल डेवलपर्स के लिए होते हैं:

• कोड समझाने के लिए
• डॉक्यूमेंटेशन के लिए
• कोड टेस्टिंग के दौरान
• डिबगिंग प्रक्रिया में

उदाहरण: जैसे आप किताब में मार्जिन पर नोट्स लिखते हैं, वैसे ही कमेंट्स कोड में नोट्स की तरह काम करते हैं।

JavaScript Comments के प्रकार

1. सिंगल लाइन कमेंट (Single Line Comment)

एक ही लाइन के लिए कमेंट लिखने के लिए // का उपयोग करें:

// यह एक सिंगल लाइन कमेंट है
let userName = "राहुल"; // यूज़र का नाम स्टोर कर रहा है

टिप: आप कमेंट को लाइन के शुरू में या कोड के बाद (एक ही लाइन में) भी लिख सकते हैं।

2. मल्टी-लाइन कमेंट (Multi-line Comment)

कई लाइनों के कमेंट के लिए /* */ का उपयोग करें:

/* यह एक मल्टी-लाइन कमेंट है जिसमें हम कई लाइनें लिख सकते हैं यह फंक्शन के डॉक्यूमेंटेशन के लिए उपयोगी है */
function calculateTotal(price, quantity) { return price * quantity; }

कमेंट्स का उपयोग कब और कैसे करें?

1. कोड समझाने के लिए

जटिल लॉजिक या एल्गोरिदम को समझाने के लिए:

// दो नंबर्स का GCD (Greatest Common Divisor) निकालने के लिए function findGCD(a, b) { if (b == 0) return a; return findGCD(b, a % b); }

2. कोड टेस्टिंग के लिए

किसी कोड को अस्थाई रूप से डिसेबल करने के लिए:

// console.log("Debug message"); // टेस्टिंग के दौरान कमेंट हटाएं

3. फंक्शन डॉक्यूमेंटेशन

फंक्शन के उद्देश्य और पैरामीटर्स को समझाने के लिए:

/** * दो नंबर्स को जोड़ता है * @param {number} a - पहला नंबर * @param {number} b - दूसरा नंबर * @returns {number} दोनों नंबर्स का योग */ function addNumbers(a, b) { return a + b; }

चेतावनी: बहुत ज्यादा कमेंट्स न लिखें। साफ और स्पष्ट कोड ही सबसे अच्छा डॉक्यूमेंटेशन होता है।

कमेंट्स के लिए बेस्ट प्रैक्टिसेज

• WHY बताएं, WHAT नहीं: कोड क्या कर रहा है यह तो कोड से पता चलता है, बताएं कि यह क्यों कर रहा है
• नियमित अपडेट: कोड बदलने पर कमेंट्स भी अपडेट करें
• स्पष्ट भाषा: सरल और स्पष्ट भाषा में कमेंट लिखें
• JSDoc स्टाइल: फंक्शन्स के लिए JSDoc स्टाइल कमेंट्स का उपयोग करें

/** * यूज़र के नाम को फॉर्मेट करता है * @param {string} firstName - यूज़र का पहला नाम * @param {string} lastName - यूज़र का अंतिम नाम * @returns {string} फॉर्मेटेड पूरा नाम */ function formatUserName(firstName, lastName) { // Capitalize first letter of each name return `${firstName[0].toUpperCase()}${firstName.slice(1)} ${lastName[0].toUpperCase()}${lastName.slice(1)}`; }

कमेंट्स से जुड़ी सामान्य गलतियाँ

1. पुराने कमेंट्स

कोड बदलने पर कमेंट अपडेट न करना:

// यूज़र का नाम प्रिंट करता है (पुराना कमेंट - अब यह नाम और उम्र दोनों प्रिंट करता है) function printUserDetails(name, age) { console.log(`Name: ${name}, Age: ${age}`); }

2. अनावश्यक कमेंट्स

स्पष्ट कोड के लिए कमेंट लिखना:

// 10 से गुणा कर रहा है (यह कमेंट अनावश्यक है) let result = number * 10;

3. कमेंटेड कोड छोड़ना

लंबे समय तक कमेंटेड कोड छोड़ना:

// function oldCalculate() { // // पुराना लॉजिक // return a + b * 2; // }

समाधान: यदि कोड की जरूरत नहीं है तो उसे डिलीट कर दें। वर्जन कंट्रोल (Git) में पुराना कोड हमेशा उपलब्ध रहेगा।

निष्कर्ष

JavaScript comments प्रोफेशनल कोडिंग का एक अभिन्न अंग हैं। सही तरीके से लिखे गए कमेंट्स:

• कोड को समझने में मदद करते हैं
• टीम कॉलैबोरेशन को बेहतर बनाते हैं
• भविष्य में कोड में बदलाव करने में सहायक होते हैं
• डॉक्यूमेंटेशन जनरेट करने में मदद करते हैं

अंतिम सुझाव: कमेंट्स और साफ कोड के बीच सही संतुलन बनाए रखें। याद रखें, अच्छा कोड स्वयं अपनी व्याख्या करता है!