वहाँ उचित RDoc वाक्यविन्यास के लिए एक अच्छा, ठोस संदर्भ है?

Question

मुझे उचित RDoc सिंटैक्स के लिए एक अच्छे, ठोस संदर्भ की तलाश है। सिफारिशें? मुझे ऐसा कुछ भी नहीं मिल रहा है जो स्पष्ट रूप से दिखाता हो:

1. कक्षा के तरीकों और उनके मापदंडों का दस्तावेजीकरण कैसे करें
2. क्लास या क्लास मेथड क्या करता है, इसका डॉक्यूमेंट कैसे करें।

Answer 1

एक आधिकारिक rdoc उदाहरण यहां पाया जा सकता है , इसके GitHub स्रोत के साथ ।

पर दस्तावेज़ rdoc.rubyforge.org पर संस्करण की तुलना में अधिक पूर्ण हो रहा है rdoc.sourceforge.net (संयोग से एक 2003 संशोधित तिथि है)।

इसके अलावा, उदाहरण का एक बड़ा स्रोत है: रूबी कोर और stdlib प्रलेखन। उदाहरण के लिए, से वर्ग तरीकों में से एक पर एक नज़र डालें Fileवर्ग :

File.atime (file_name) => समय

नाम फ़ाइल के लिए अंतिम पहुँच समय को समय ऑब्जेक्ट के रूप में देता है)।

File.atime("testfile") #=> Wed Apr 09 08:51:48 CDT 2003

आप मूल स्रोत कोड देख सकते हैं, जिसमें RDoc मार्कअप भी शामिल है, पहली पंक्ति पर क्लिक करके (वास्तविक RDoc पृष्ठ में, इस उत्तर में शामिल उद्धरण में नहीं)। इस मामले में, विधि C में लागू की गई थी, लेकिन RDoc प्रारूपण वही है जैसे कि इसे रूबी में लागू किया गया था:

/*
 *  call-seq:
 *     File.atime(file_name)  =>  time
 *  
 *  Returns the last access time for the named file as a Time object).
 *     
 *     File.atime("testfile")   #=> Wed Apr 09 08:51:48 CDT 2003
 *     
 */

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

Comments

मैं बस यही ढूंढ रहा था। ध्यान दें कि rdoc.rubyforge.org/RDoc/Markup.html में (जैसा लगता है) आधिकारिक कल्पना है। इसके लिए खोजें: RDoc Markup Reference Darn! मुझे वास्तव में दूसरी टिप्पणी भी पढ़नी चाहिए थी

— मार्टिन एम।

निश्चित नहीं है कि यह नए संस्करणों पर भी लागू होता है, लेकिन मेरे 1.9.3 रूबी के साथ, यह --markupविकल्प का समर्थन करने की कोशिश नहीं करता है ( rdoc.rubyforge.org/RDoc/Markup.html#label-Sadorted+markdown पर उल्लेख किया गया है ) प्रारूप - क्या मुझे कुछ याद आ रहा है?

— फ्रेंड एफएक्स 20'13

रूबीफोर्ज लिंक डेड।

— सिरो संतिली 郝海东 冠状 iro i 法轮功 ''

docs.seattlerb.org/rdoc/RDoc/Markup.html केवल इस पृष्ठ पर बचा हुआ लिंक है। उस एक का उपयोग करने के लिए अपने उत्तर को संपादित करें?

— मार्क अमेरी

मुझे उत्तर में उल्लिखित स्रोत कोड का लिंक नहीं मिला (जो कहता है कि यह "पहली पंक्ति पर क्लिक करके पहुँचा जा सकता है (वास्तविक RDoc पृष्ठ में, इस उद्धरण में शामिल नहीं है जो इस उत्तर में शामिल है)"। रूबी फ़ाइल मॉड्यूल स्रोत कोड

— gen_wood

Answer 2

चूंकि रूबीफॉर्ग सेवानिवृत्त हो चुका है , यहां एक नई कड़ी है:

http://ruby-doc.org/stdlib-2.5.1/libdoc/rdoc/rdoc/RDoc/Markup.html

Comments

यह भी बहुत अच्छा लगता है: docs.seattlerb.org/rdoc/RDoc/Markup.html

— स्टीव

पुराना लिंक अब नए संस्करण के साथ मृत हो गया है। वर्तमान: रूबी- doc.org/gems/docs/r/rdoc-4.1.2/RDoc/Markup.html

— m.silenus

यह बेतुका है। सभी रूबी-डॉक लिंक मृत हैं, लेकिन यह काम करने लगता है: ruby-doc.org/stdlib-2.2.3/libdoc/rdoc/rdoc/RDoc/Markup.html लेकिन कितने समय के लिए ...?

— ब्रोंसन