रूबी कोड के लिए टिप्पणियाँ (उपयोग, एकल और बहु-पंक्ति)

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

यह आमतौर पर कक्षाओं और विधियों के साथ-साथ किसी भी कोड के टुकड़े से पहले टिप्पणी करने के लिए अच्छा रूप है जो जटिल या अस्पष्ट हो सकता है।

टिप्पणियों का उपयोग पृष्ठभूमि की जानकारी देने या कठिन कोड को एनोटेट करने के लिए किया जाना चाहिए। नोट्स जो सीधे-सीधे कहते हैं कि सीधी कोड की अगली पंक्ति न केवल स्पष्ट है, बल्कि फ़ाइल में अव्यवस्था भी जोड़ सकती है।

यह ध्यान रखना महत्वपूर्ण है कि बहुत सारी टिप्पणियों का उपयोग न करें और यह सुनिश्चित करें कि फ़ाइल में की गई टिप्पणियाँ अन्य प्रोग्रामर के लिए सार्थक और सहायक हों।

आप देखेंगे कि सभी रूबी कार्यक्रम एक टिप्पणी के साथ शुरू होते हैं जो इसके साथ शुरू होता है #!. इसे ए कहते हैं कुटिया और लिनक्स, यूनिक्स और ओएस एक्स सिस्टम पर उपयोग किया जाता है।

जब आप एक रूबी स्क्रिप्ट निष्पादित करते हैं, तो शेल (जैसे लिनक्स या ओएस एक्स पर बैश) फ़ाइल की पहली पंक्ति में एक शेल्फ़ की तलाश करेगा। शेल तब रूबी दुभाषिया खोजने और स्क्रिप्ट चलाने के लिए शेबंग का उपयोग करेगा।

पसंदीदा रूबी शेबंग है #! / usr / bin / env माणिक, हालांकि आप भी देख सकते हैं #! / Usr / bin / माणिक या #! / Usr / स्थानीय / bin / माणिक.

रूबी सिंगल-लाइन टिप्पणी के साथ शुरू होता है # वर्ण और पंक्ति के अंत में समाप्त होता है। से कोई भी पात्र # रूबी दुभाषिया द्वारा पंक्ति के अंत तक के चरित्र को पूरी तरह से अनदेखा किया जाता है।

# चरित्र को लाइन की शुरुआत में होना जरूरी नहीं है; यह कहीं भी हो सकता है।

निम्नलिखित उदाहरण टिप्पणियों के कुछ उपयोगों को दिखाता है।

 #! / usr / bin / env माणिक

 # रूबी दुभाषिया द्वारा इस रेखा को अनदेखा किया जाता है

 # यह विधि अपने तर्कों के योग को छापती है

 डिम सम (ए, बी)

 अ + ब डालता है

 समाप्त

 sum (10,20) # 10 और 20 का योग प्रिंट करें 

हालांकि अक्सर कई रूबी प्रोग्रामर भूल जाते हैं, रूबी के पास मल्टी-लाइन टिप्पणियां हैं। मल्टी-लाइन टिप्पणी के साथ शुरू होता है = शुरू टोकन और के साथ समाप्त होता है = अंत टोकन।

ये टोकन लाइन की शुरुआत में शुरू होने चाहिए और लाइन पर केवल एक चीज होनी चाहिए। इन दो टोकनों के बीच कुछ भी रूबी दुभाषिया की अनदेखी है।

 #! / usr / bin / env माणिक

 = शुरू

 = आरंभ और = अंत के बीच, कोई भी संख्या

 लाइनें लिखी जा सकती हैं। ये सभी

 रूबी दुभाषिया द्वारा लाइनों की अनदेखी की जाती है।

 = अंत

 "हैलो वर्ल्ड!"

इस उदाहरण में, कोड के रूप में निष्पादित करेगा नमस्ते दुनिया!