यार्ड का उपयोग करते समय कोड पर टिप्पणी न करें

मेरे पास कुछ रूबी कोड है जो इस तरह दिखता है:

# some_string = "{really?}"

जहां घुंघराले ब्रेसिज़ स्ट्रिंग का हिस्सा होना चाहिए। इस लाइन को कोड पर टिप्पणी की गई है कि मैं वहां रहना चाहता हूं। मैं अतिरिक्त रूप से दस्तावेज़ कोड करने के लिए यार्ड का उपयोग कर रहा हूं, इसलिए जब मैं yard doc चलाता हूं तो यह (स्वाभाविक रूप से) "वास्तव में" लिंक करने में असमर्थ होने के बारे में चेतावनी फेंकता है।

क्या कोई तरीका है कि मैं यार्ड को टिप्पणी कोड को अनदेखा करने के लिए कह सकता हूं?

0
कोई अच्छा कारण नहीं है। मैं आमतौर पर कोड के खंडों को टिप्पणी करता हूं (यही संशोधन नियंत्रण है), लेकिन ऐसा लगता है कि यह संभव होना चाहिए। इसके अलावा कभी-कभी टिप्पणी की जाती है कि एक अच्छे कारण के लिए कोड छोड़ा जा सकता है, हालांकि मैं अभी एक के बारे में नहीं सोच सकता।
जोड़ा लेखक G Gordon Worley III, स्रोत
आप कोड को किसके लिए रखते हैं? टिप्पणी-आउट कोड का एक विकल्प हो सकता है जो आपके लिए एक ही उद्देश्य प्रदान करता है, और जो भी आपको परेशान करने की आवश्यकता है उससे कम प्रयास है।
जोड़ा लेखक Neil Slater, स्रोत

1 उत्तर

क्या कोई तरीका है कि मैं यार्ड को टिप्पणी कोड को अनदेखा करने के लिए कह सकता हूं?

एक ओर, यार्ड Rdoc मार्कअप का समर्थन करने के रूप में दस्तावेज है। और आरडीओसी को भागों को छिपाने के कुछ तरीकों का समर्थन करने के लिए दस्तावेज किया गया है।

आरडीओसी टिप्पणियों को संसाधित करता है अगर उसे एक टिप्पणी लाइन शुरू हो जाती है   साथ - # चरित्र के ठीक बाद (अन्यथा, इसका इलाज किया जाएगा   एक नियम अगर इसमें तीन डैश या अधिक हैं)। इसे अलग करने के लिए इस्तेमाल किया जा सकता है   आंतरिक टिप्पणियों से बाहरी, या एक टिप्पणी को जोड़ने से रोकने के लिए   एक विधि, कक्षा, या मॉड्यूल के साथ। टिप्पणी को वापस चालू किया जा सकता है   एक पंक्ति जो ++ से शुरू होती है।

     

: stopdoc: /: startdoc:
      रोकें और वर्तमान में नए दस्तावेज़ तत्व जोड़ने शुरू करें   कंटेनर। उदाहरण के लिए, यदि किसी वर्ग में कई स्थिरांक हैं जो आप हैं   दस्तावेज नहीं करना चाहते हैं, एक डालें: स्टॉपडोक: पहले से पहले, और ए   : startdoc: आखिरी के बाद। यदि आप एक निर्दिष्ट नहीं करते हैं: startdoc: अंत तक   कंटेनर के बाकी हिस्सों के लिए दस्तावेज अक्षम करता है   फ़ाइल।

स्रोत

दूसरी तरफ, मैंने उस मार्कअप का पालन करने के लिए कभी भी राडोक या यार्ड को राजी नहीं किया है। यदि आपकी किस्मत मेरी तुलना में बेहतर है, तो आप यहां पढ़ना बंद कर सकते हैं।

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

अंत में, रेक आपको पाठ (कोड) फ़ाइलों को मनमाने तरीके से रूपांतरित करने देता है। आप यार्ड के माध्यम से प्रसंस्करण से पहले लाइनों को हटाने के लिए एक रेकैकाइल लिख सकते हैं।

$ cat silly-ruby-file.src 
class Something

  def this_method
  end

  def that_method
    # some_string = "{really?}" # Hide me
  end
end

मैंने टेक्स्ट # मुझे छुपाएं जोड़ दिया; मनमाने ढंग से कोड की टिप्पणी लाइनों को फ़िल्टर करने के लिए यह उस विशिष्ट टेक्स्ट को फ़िल्टर करने के लिए बहुत आसान है।

$ cat Rakefile
task :default => "silly-ruby-file.rb"
sh "grep -v '# Hide me' silly-ruby-file.src > silly-ruby-file.rb"

यह grep चलाने के लिए gake को चलाने के लिए grep को चलाने के लिए बताता है, जिसमें सभी पंक्तियों की प्रतिलिपि है, जिनके पास "# मुझे छुपाएं" stdout पर पाठ है, जिसे "silly-ruby-file.rb पर रीडायरेक्ट किया गया है "।

0
जोड़ा