كيف يمكنني معالجة ملف readMe مع RDOC لعرض معلومات التعليم/الاستخدام السينمائي Ruby

Question

أرغب في الحفاظ على مستندات الاستخدام الخاصة بي في ملف readme (duh) بدلاً من التعليقات في الجزء العلوي من البرنامج النصي. كيف أحصل على RDOC :: الاستخدام لسحب معلومات الاستخدام من README بدلاً من تعليقات البرنامج النصي؟

Answer 1

تم تصميم RDOC لتحليل ملف مصدر ، وإلقاء نظرة على التعليقات ومواقعها ، وإنشاء مراجعات متقاطعة للمتغيرات ، وعند الانتهاء ، قم بربطها جميعًا في مخرجات لائقة. نظرًا لأن RDOC مصمم للعمل ضد ملفات المصدر ، فقد لا يكون الخيار الأفضل لما تريد القيام به.

بدلاً من ذلك قد ترغب في النظر إلى حديقة منزل, ، وهو يعتمد على العلامة. هل يمكنني الحصول على readme.textile في RDOC الخاص بي مع التنسيق المناسب؟ لديه بعض المعلومات المفيدة لك أيضًا.

في كلتا الحالتين ، إذا لم تتمكن من الحصول على التطبيق لتحليل مستند من نوع ReadMe كما تريد ، فقد تتمكن المعلمات ، والكرات ، وغيرها من "ما" لا يحتاجون إلى إنشاء وثائق قابلة للاستخدام.

خلاف ذلك ، من المحتمل أن تضطر إلى التخلي عن استخدام المساعدة الآلية واكتبها جميعًا.

توصيتي هي القيام بذلك بالطريقة RDOC ، وتوثيق داخل الكود الخاص بك. ليس من الصعب القيام به على الإطلاق ، ويمكن أن يكون المخرج مرضيًا للغاية. إنه لأمر مدهش مدى جودة عمل RDOC.

Answer 2

من المؤكد أنني لست من ذوي الخبرة بما يكفي لأخبرك بالإجابة ، لكن من فضلك اسمح لي بنصيحة واحدة.

من غير المرجح أن يقوم معظم المطورين بتحديث الوثائق حتى لو كان 3 أسطر من التعليمات البرمجية فوق التنفيذ.

اعمل معروفًا ولا تجعل العملية أكثر صعوبة.

إن الحفاظ على الوثائق العامة منفصلة هو فكرة رائعة ، لكن ليس لديها ما تفعله في مخرجك الذي تم إنشاؤه بواسطة RDOC على أي حال.