Computer >> कंप्यूटर ट्यूटोरियल >  >> प्रोग्रामिंग >> Ruby

रूबी कमेंट्स में महारत हासिल करें: क्लीन कोड के लिए 5 प्रकार और बेस्ट प्रैक्टिसेज

रूबी में कमेंट्स क्या हैं?

एक रूबी कमेंट आपके कोड में जानकारी जोड़ता है जो आपके या अन्य डेवलपर्स के लिए मददगार हो सकती है।

सबसे सामान्य प्रकार का कमेंट सिंगल-लाइन कमेंट है।

यहाँ सिंटैक्स है:

# I like apples & oranges

तीन चीजें नोटिस करें:

  1. कमेंट पाउंड (#) सिंबल से शुरू होता है
  2. हम कमेंट की सामग्री और कमेंट की शुरुआत के बीच एक स्पेस डालते हैं ताकि इसे पढ़ना आसान हो
  3. कमेंट के अंदर सब कुछ कोड के रूप में इंटरप्रेट नहीं किया जाता, भले ही यह कोड जैसा दिखे। इसका मतलब है कि आप कोड को अस्थायी रूप से कमेंट आउट करके डिसेबल कर सकते हैं।

आप इन कमेंट्स का उपयोग स्वयं या इंलाइन, कोड की लाइन के अंत में कर सकते हैं।

इस तरह:

[].size # get array size

क्या अन्य प्रकार के कमेंट्स हैं?

हां, मैजिक कमेंट्स, मल्टीलाइन कमेंट्स और ERB कमेंट्स हैं।

आइए उनको एक्सप्लोर करते हैं!

रूबी में मल्टी-लाइन कमेंट्स का उपयोग कैसे करें

रूबी में, हम रेगुलर, सिंगल-लाइन कमेंट्स के साथ मल्टीलाइन कमेंट्स करते हैं।

कुछ लोग इन्हें "ब्लॉक कमेंट्स" कहते हैं।

यहाँ एक उदाहरण है:

# aaa
# bbb
# ccc

रूबी में कोड के ब्लॉक को कमेंट आउट करने का यही तरीका है।

आधुनिक कोड एडिटर्स आपको कोड के ब्लॉक को सिलेक्ट करने और कीबोर्ड शॉर्टकट का उपयोग करके उन सभी को कमेंट करने की अनुमति देते हैं, इसलिए इसमें कोई अतिरिक्त प्रयास शामिल नहीं है।

लेकिन एक विशेष मल्टीलाइन कमेंट सिंटैक्स है।

यह इस तरह दिखता है:

=begin
This is a comment...
a
b
c
=end

कोई भी इस सिंटैक्स का उपयोग नहीं करता...

यह बदसूरत है और आप इसे किसी भी चीज़ के अंदर उपयोग भी नहीं कर सकते जो इंडेंटेड है (जैसे मेथड), लेकिन यह जानना अच्छा है कि यह मौजूद है यदि आप कभी इसे जंगल में पाते हैं।

शेबैंग कमेंट्स

एक शेबैंग (#!) एक विशेष प्रकार का कमेंट है जो यूनिक्स शेल (जैसे bash) को बताता है कि इस फाइल को कैसे इंटरप्रेट करना है।

जब आप इस कमेंट को अपनी फाइल के टॉप पर जोड़ते हैं...

आप अपनी रूबी फाइलों को एक्जीक्यूटेबल फाइलों के रूप में चला पाएंगे, यह मानते हुए कि उनके पास ऐसा करने के लिए सही परमिशन हैं।

यहाँ एक शेबैंग कमेंट कैसा दिखता है:

#!/usr/bin/env ruby

यह आपको विशिष्ट कमांड-लाइन विकल्प सेट करने की भी अनुमति देता है, जैसे वार्निंग विकल्प।

उदाहरण:

#!/usr/bin/env ruby -w

हर बार जब आप इस कोड को चलाते हैं तो यह इन विकल्पों के साथ चलेगा, इसलिए आपको उन्हें मैन्युअली पास नहीं करना पड़ेगा।

मैजिक कमेंट्स का उपयोग कैसे करें

एक मैजिक कमेंट रूबी इंटरप्रेटर के व्यवहार को किसी तरह से बदलता है।

उदाहरण के लिए:

frozen_string_literals कमेंट आपकी स्ट्रिंग्स को डिफ़ॉल्ट रूप से फ्रोज़न बना देगा।

यह इस तरह दिखता है:

# frozen_string_literal: true

एक और मैजिक कमेंट आपको फाइल की एन्कोडिंग बदलने की अनुमति देता है।

यहाँ एक उदाहरण है:

# encoding: utf-8

एक यहाँ दिलचस्प है, warn_indent कमेंट:

# warn_indent: true

यह आपके इंडेंटेशन गलत होने पर चेतावनी दिखाएगा।

उदाहरण:

def comments
end

जिसके परिणामस्वरूप:

warning: mismatched indentations at 'end' with 'def' at 3

ERB कमेंट्स

यदि आप अपने Rails व्यूज के लिए ERB का उपयोग कर रहे हैं और आपको एक कमेंट जोड़ने की आवश्यकता है...

तब आप इस सिंटैक्स का उपयोग कर सकते हैं:

<%# ERB comment %>

मैं इसका बड़ा प्रशंसक नहीं हूं क्योंकि मेरा मानना है कि आपको अपना अधिकांश लॉजिक अपने व्यूज से बाहर रखना चाहिए इसलिए आपको किसी कमेंट की आवश्यकता नहीं होनी चाहिए।

डीबगिंग के लिए कुछ कोड अक्षम करना चाहते हैं?

तब उस कोड को डिलीट करें और git पर भरोसा करें, या जो भी वर्जन कंट्रोल सिस्टम आप उपयोग कर रहे हैं।

सारांश

आपने विभिन्न प्रकार के रूबी कमेंट्स के बारे में सीखा, जिसमें रेगुलर कमेंट्स (#), शेबैंग कमेंट्स (#!) और मैजिक कमेंट्स (# frozen_string_literal: true) शामिल हैं!

यदि आपको यह लेख मददगार लगा तो कृपया इसे किसी मित्र के साथ शेयर करें ताकि वह भी इसका आनंद ले सके।

पढ़ने के लिए धन्यवाद!

  1. रूबी में Rake में महारत हासिल करें: टास्क ऑटोमेशन के लिए पूर्ण गाइड रूबी में Rake में महारत हासिल करें: टास्क ऑटोमेशन के लिए पूर्ण गाइड

    Rake रूबी में एक लोकप्रिय टास्क रनर है। टास्क क्या है? अपने डेटाबेस का बैकअप बनाना अपने टेस्ट्स चलाना आंकड़े इकट्ठा करना और रिपोर्ट करना ये छोटे टास्क हैं जो Rake के बिना आपकी प्रोजेक्ट पर अलग-अलग फाइलों में बिखरे होंगे। Rake आपके टास्क्स तक पहुंच को केंद्रीकृत करता है। Rake कुछ चीजों को आसान भी ब

  1. रूबी मैट्रिक्स को समझना: परिभाषा, अनुप्रयोग और उन्हें कैसे बनाएं रूबी मैट्रिक्स को समझना: परिभाषा, अनुप्रयोग और उन्हें कैसे बनाएं

    मैट्रिक्स एक 2D (2-डायमेंशनल) ऐरे है जिसका उपयोग स्प्रेडशीट जैसे डेटा को स्टोर और काम करने के लिए किया जा सकता है। इनका उपयोग किया जा सकता है: टेबल गेम में बोर्ड को दर्शाना (शतरंज, चेकर्स, आदि) आंकड़े और डेटा विश्लेषण प्लॉट्स और ग्राफ़ उत्पन्न करना क्योंकि यह एक शक्तिशाली डेटा संरचना है इसलिए इसका

  1. रूबी स्ट्रक्ट्स और OpenStruct में महारत: कुशल वैल्यू ऑब्जेक्ट्स रूबी स्ट्रक्ट्स और OpenStruct में महारत: कुशल वैल्यू ऑब्जेक्ट्स

    रूबी में स्ट्रक्ट क्या है? एक स्ट्रक्ट एक बिल्ट-इन रूबी क्लास है, इसका उपयोग वैल्यू ऑब्जेक्ट्स उत्पन्न करने वाली नई क्लासेस बनाने के लिए किया जाता है। एक वैल्यू ऑब्जेक्ट संबंधित विशेषताओं को एक साथ संग्रहीत करने के लिए उपयोग किया जाता है। यहां एक उदाहरण है: दो निर्देशांकों (x और y) के साथ एक Point।