स्विफ्ट टिप्पणियाँ: उनका उपयोग कैसे करें और क्यों?

इस लेख में, आप स्विफ्ट टिप्पणियों के बारे में जानेंगे, उनका उपयोग क्यों और कैसे करें।

एक टिप्पणी कार्यक्रम के स्रोत कोड में एक प्रोग्रामर-पठनीय स्पष्टीकरण या एनोटेशन है। कोड संकलित होने पर यह संकलक द्वारा अनदेखा किया जाता है।

टिप्पणियाँ उस व्यक्ति के लिए होती हैं जो प्रोग्राम के इरादे और कार्यक्षमता को बेहतर ढंग से समझने के लिए कोड को पढ़ता है। टीम के अन्य सदस्यों के लिए कोड के उद्देश्य को स्पष्ट करने के लिए या पूरी तरह से काम करते समय यह मददगार हो सकता है, जबकि यह स्वयं के लिए अनुस्मारक के रूप में कार्य कर सकता है।

स्विफ्ट टिप्पणी और इसके प्रकार

स्विफ्ट में दो तरह की टिप्पणियां हैं:

1. सिंगल लाइन टिप्पणी

स्विफ्ट में, दो स्लैश //से शुरू होने वाली कोई भी लाइन एक सिंगल लाइन कमेंट है। दो स्लैश //से शुरू होने वाली हर चीज को कंपाइलर द्वारा नजरअंदाज किया जाता है।

आप खेल के मैदान के शीर्ष पर एक सरल उदाहरण पा सकते हैं:

 //: खेल का मैदान - संज्ञा: एक जगह जहां लोग खेल सकते हैं

यह दो स्लैश के साथ शुरू होता है //और ": खेल का मैदान - संज्ञा: एक जगह है जहाँ लोग खेल सकते हैं" के रूप में फ़ाइल का सार्थक विवरण प्रदान करते हैं।

उदाहरण 1: सिंगल लाइन टिप्पणी

 //Sample program //stores 3.14 in variable pi let pi = 3.14159 print(pi) 

उपरोक्त उदाहरण में दो एकल पंक्ति टिप्पणी है:

 // नमूना कार्यक्रम // स्टोरेज चर में 3.14

2. बहुभाषी टिप्पणी

यदि आपकी टिप्पणी में कई लाइन शामिल हैं, तो आप इसे अंदर संलग्न कर सकते हैं /*… */।

बहुस्तरीय टिप्पणियां एक आगे-स्लेश के साथ शुरू होती हैं, जिसके बाद एक तारांकन चिह्न ( /*) और एक आगे-स्लेश ( */) के बाद तारांकन चिह्न के साथ समाप्त होता है । बीच में सब कुछ /*और */स्विफ्ट कंपाइलर द्वारा अनदेखा किया जाता है।

/ * यह एक बहुस्तरीय टिप्पणी है। बहुस्तरीय टिप्पणी लिखने के बाद * इसे समाप्त करने के लिए * का अनुसरण करें / *

उदाहरण 2: बहुस्तरीय टिप्पणी

 /* Hardcoded pi value may be less accurate. So you can calculate using in built data types for more accurate value */ let pi = Double.pi print(pi) 

उपरोक्त उदाहरण में एक बहुस्तरीय टिप्पणी है।

/ * हार्डकोड पाई का मान कम सटीक हो सकता है। तो आप अधिक सटीक मूल्य के लिए निर्मित डेटा प्रकारों में उपयोग की गणना कर सकते हैं * /

याद रखने वाली चीज़ें

हालांकि टिप्पणियाँ लिखित कोड के इरादे को बेहतर ढंग से समझने के लिए सार्थक हैं। इसे लिखते समय आपको जिन बातों पर विचार करने की आवश्यकता है:

1. मल्टीलाइन पर // के साथ टिप्पणियों को संलग्न न करें हालांकि यह वैध है और संकलक उन पंक्तियों को अनदेखा करता है। इसके बजाय इसे बहुभाषी टिप्पणी के अंदर संलग्न करें /*… */
   उदाहरण:

   // यह एक टिप्पणी है। // जब आवश्यक हो और ठीक उपयोग करें

   टिप्पणी लिखने का उपरोक्त तरीका सही है लेकिन अनुशंसित नहीं है क्योंकि आपको टिप्पणी एक पंक्ति से अधिक होने पर बहुस्तरीय टिप्पणी लिखने की आवश्यकता है। लिखने का बेहतर तरीका बहुस्तरीय टिप्पणी का उपयोग कर रहा है:

   / * यह एक टिप्पणी है। जब आवश्यक हो और ठीक * /

2. सिंगल लाइन टिप्पणी को एक अलग लाइन में या उसी लाइन में कोड के साथ लिखा जा सकता है। हालांकि, एक अलग लाइन में टिप्पणियों का उपयोग करने की सिफारिश की जाती है।
   उदाहरण:

    pi = 3.14159 // स्टोर्स को 3.14 वेरिएबल पाई में दें

   टिप्पणी लिखने का यह तरीका मान्य है। लेकिन एक अलग पंक्ति में टिप्पणी लिखना बेहतर है:

    // स्टोरेज 3.14 वेरिएबल पीआई में pi = 3.14159 

3. यहां तक ​​कि अगर आप एक टीम में एक एकल डेवलपर हैं, और आप केवल एक ही कोड लिख रहे हैं, अगर यह असुविधाजनक है, तो आपको कार्यक्रम में इसके उद्देश्य का पता लगाने की कोशिश करने में कठिन समय होगा। तो, इसका सटीक उपयोग करें और एक सार्थक विवरण प्रदान करें।
4. टिप्पणी को बहुत सरल और सार्थक बनाएं।
5. अपने कोड पर अनावश्यक टिप्पणी न लिखें।
6. ज्यादातर मामलों में, 'कैसे' के बजाय 'क्यों' समझाने के लिए टिप्पणियों का उपयोग करें।