ऐसा लगता है पुस्तकालयों/plugins का एक बहुत इस वाक्य रचना का उपयोग करें:": nodoc:" वाक्यविन्यास क्यों आवश्यक है?
def self.included(base) # :nodoc:
base.extend ClassMethods
end
क्यों :nodoc: भाग के लिए आवश्यक है?
यह आवश्यक नहीं है। यदि किसी वर्ग पर लागू होता है, तो यह कक्षा विस्तार में सभी विधियों के लिए दस्तावेज़ (rdoc) को दबाता है।
: के रूप में प्रोग्रामिंग रूबी में वर्णित nodoc: - दस्तावेज में इस तत्व शामिल न करें। कक्षाओं और मॉड्यूल के लिए, विधियों, उपनाम, स्थिरांक, और प्रभावित वर्ग या मॉड्यूल के भीतर सीधे विशेषताएँ दस्तावेज़ों से भी छोड़ी जाएंगी। डिफ़ॉल्ट रूप से, हालांकि, उस कक्षा के भीतर मॉड्यूल और कक्षाएं या मॉड्यूल को दस्तावेज किया जाएगा।
मुझे नहीं लगता कि यह आवश्यक है। दरअसल, मेरी राय में, यह आरडीओसी की सबसे बेकार सुविधाओं में से एक है।
लिबररी कोड पढ़ने के दौरान मैंने इसे कई बार देखा है और मुझे खुद से पूछना पड़ा "क्यों?"। मुझे इस सुविधा का उपयोग करने का कोई कारण नहीं दिख रहा है। यदि आप नहीं चाहते हैं कि लोग आपकी विधि का उपयोग करें, तो बस इसे निजी बनाएं। प्रलेखन पढ़ने और दस्तावेज़ीकरण से बाहर निकलने वाली विधि को विधि कॉल देखने पर यह एक बड़ी परेशानी है।
आपके पास एक बिंदु है। मैं इस बात से सहमत नहीं हूं कि ': नोडोक:' कभी भी उपयोगी नहीं हो सकता है। लेकिन यह अधिक उपयोग किया जाता है, लोग इसे किसी भी तरह से "महत्वहीन" मानते हैं, या लेखन दस्तावेज से बचने के तरीके के रूप में उपयोग करते हैं, जब वे लिखने के बारे में नहीं सोच सकते हैं। –
विडंबनात्मक तरीकों को "महत्वहीन" माना जाता है, आमतौर पर वे सोचते हैं कि "यह ऐसा क्यों करता है?" सोचने के बारे में मेरे सिर को खरोंच कर रहा हूं। उन लोगों के लिए: nodoc: 'एक कोड (दस्तावेज?) गंध है ... –