2008-08-01 11 views
35

मैं अपनी मौजूदा टिप्पणियों को 'आरडीओसी टिप्पणियों' के रूप में प्रारूपित करना चाहता हूं ताकि उन्हें ri का उपयोग करके देखा जा सके।रूबी में आरडीओसी में मौजूदा टिप्पणियां कैसे जोड़ूं?

आरडीओसी का उपयोग शुरू करने के लिए कुछ अनुशंसित संसाधन क्या हैं?

+1

काम नहीं करता है में [डॉक्स] एक नजर डालें (http://docs.seattlerb.org/rdoc/) – Tobias

उत्तर

8

आरडीओसी सरल मार्ककअप का उपयोग करता है, इसलिए *, - या एक संख्या का उपयोग करके सूचियां आदि बनाना काफी आसान है। यह उन पंक्तियों का भी इलाज करता है जो समान पैराग्राफ के हिस्से के समान कॉलम नंबर पर इंडेंट किए जाते हैं जब तक कि एक खाली रेखा न हो जो एक नया अनुच्छेद दर्शाती है। क्या आपके पास टिप्पणियों के कुछ उदाहरण हैं जिन्हें आप आरडीओसी करना चाहते हैं ताकि हम आपको दिखा सकें कि उन्हें कैसे करें और फिर आप अपनी बाकी टिप्पणियों के लिए इसे बाहर कर सकते हैं?

13

कुछ बातें है कि मुझे काट लिया है

  • :main: - RDoc केवल पिछले का मूल्यांकन एक उपयोग करता है; यह सुनिश्चित करने के लिए सबसे अच्छा है कि आपकी परियोजना में केवल एक ही है और आप --main कमांड-लाइन तर्क का भी उपयोग नहीं करते हैं।
  • पिछले के रूप में ही है, लेकिन के लिए :title:
  • :section: बहुत अच्छी तरह से
संबंधित मुद्दे