इस लेख में, हम C # टिप्पणियों, टिप्पणियों की विभिन्न शैली और एक कार्यक्रम में उनका उपयोग क्यों और कैसे करें के बारे में जानेंगे।
एक कार्यक्रम में कोड के एक टुकड़े को समझने में हमारी सहायता के लिए टिप्पणियों का उपयोग किया जाता है। वे मानव पठनीय शब्द हैं जिनका उद्देश्य कोड को पठनीय बनाना है। टिप्पणियाँ पूरी तरह से संकलक द्वारा नजरअंदाज कर रहे हैं।
C # में, 3 प्रकार की टिप्पणियां हैं:
- एकल पंक्ति टिप्पणियाँ (
//) - मल्टी लाइन टिप्पणियाँ (
/* */) - XML टिप्पणियाँ (
///)
सिंगल लाइन टिप्पणियाँ
सिंगल लाइन कमेंट्स डबल स्लैश से शुरू होते हैं //। कंपाइलर //लाइन के अंत के बाद सब कुछ अनदेखा करता है । उदाहरण के लिए,
int a = 5 + 7; // 5 और 7 को जोड़ना
यहाँ, Adding 5 and 7टिप्पणी है।
उदाहरण 1: एकल पंक्ति टिप्पणी का उपयोग करना
// Hello World Program using System; namespace HelloWorld ( class Program ( public static void Main(string() args) // Execution Starts from Main method ( // Prints Hello World Console.WriteLine("Hello World!"); ) ) )
उपरोक्त कार्यक्रम में 3 एकल पंक्ति टिप्पणियाँ हैं:
// हैलो वर्ल्ड प्रोग्राम // मुख्य विधि से निष्पादन शुरू होता है
तथा
// प्रिंट्स हैलो वर्ल्ड
एकल पंक्ति टिप्पणियों को एक अलग पंक्ति में या उसी पंक्ति में कोड के साथ लिखा जा सकता है। हालांकि, एक अलग लाइन में टिप्पणियों का उपयोग करने की सिफारिश की जाती है।
मल्टी लाइन टिप्पणियाँ
मल्टी लाइन टिप्पणी के साथ शुरू /*होता है और समाप्त होता है */। मल्टी लाइन टिप्पणियां कई लाइनों पर हो सकती हैं।
उदाहरण 2: मल्टी लाइन टिप्पणी का उपयोग करना
/* This is a Hello World Program in C#. This program prints Hello World. */ using System; namespace HelloWorld ( class Program ( public static void Main(string() args) ( /* Prints Hello World */ Console.WriteLine("Hello World!"); ) ) )
उपरोक्त कार्यक्रम में 2 बहु पंक्ति टिप्पणियाँ हैं:
/ * यह C # में एक हैलो वर्ल्ड प्रोग्राम है। यह कार्यक्रम हैलो वर्ल्ड को प्रिंट करता है। * /
तथा
/ * प्रिंट हैलो वर्ल्ड * /
यहाँ, हमने देखा होगा कि मल्टी लाइन कमेंट के लिए मल्टीपल लाइन्स का विस्तार करना अनिवार्य नहीं है। /*… */सिंगल लाइन टिप्पणियों के बजाय इस्तेमाल किया जा सकता है।
XML प्रलेखन टिप्पणियाँ
XML प्रलेखन टिप्पणी C # में एक विशेष सुविधा है। यह एक ट्रिपल स्लैश के साथ शुरू होता है ///और कोड के एक टुकड़े को स्पष्ट रूप से वर्णन करने के लिए उपयोग किया जाता है … यह एक टिप्पणी के भीतर XML टैग का उपयोग करके किया जाता है। इन टिप्पणियों को तब एक अलग XML प्रलेखन फ़ाइल बनाने के लिए उपयोग किया जाता है।
यदि आप XML से परिचित नहीं हैं, तो देखें कि XML क्या है?
उदाहरण 3: XML प्रलेखन टिप्पणी का उपयोग करना
/// /// This is a hello world program. /// using System; namespace HelloWorld ( class Program ( public static void Main(string() args) ( Console.WriteLine("Hello World!"); ) ) )
उपरोक्त कार्यक्रम में प्रयुक्त XML टिप्पणी है
/// /// यह एक हैलो वर्ल्ड प्रोग्राम है। ///
XML दस्तावेज़ (.xml फ़ाइल) में जनरेट किया जाएगा:
नमस्ते दुनिया
यदि आप अधिक सीखने में रुचि रखते हैं, तो XML प्रलेखन टिप्पणियाँ पर जाएँ।
टिप्पणियों का सही तरीके से उपयोग करें
टिप्पणियों का उपयोग कोड के कुछ हिस्सों को समझाने के लिए किया जाता है, लेकिन उनका उपयोग नहीं किया जाना चाहिए।
उदाहरण के लिए:
// प्रिंट्स हैलो वर्ल्ड कंसोल। क्राइटलाइन ("हैलो वर्ल्ड");
उपरोक्त उदाहरण में टिप्पणी का उपयोग करना आवश्यक नहीं है। यह स्पष्ट है कि लाइन हैलो वर्ल्ड को प्रिंट करेगी। ऐसे मामलों में टिप्पणियों से बचना चाहिए।
- इसके बजाय जटिल एल्गोरिदम और तकनीकों को समझाने के लिए कार्यक्रम में टिप्पणियों का उपयोग किया जाना चाहिए।
- टिप्पणियाँ लंबे विवरण के बजाय संक्षिप्त और बिंदु तक होनी चाहिए।
- एक सामान्य नियम के रूप में, यह समझाने के लिए बेहतर है क्यों के बजाय कैसे , टिप्पणियों का उपयोग कर।
