هل هناك مرجع جيد وصلب لبناء RDOC المناسب؟

Question

أنا أبحث عن مرجع جيد وصلب لبناء RDOC المناسب. توصيات؟ لا يمكنني العثور على أي شيء يظهر بوضوح:

1. كيفية توثيق أساليب الفصل ومعلماتها
2. كيفية توثيق ما تفعله طريقة الفصل أو الفصل.

Answer 1

يمكن العثور على مثال رسمي RDOC هنا, ، مع ل مصدر جيثب.

الوثائق في 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 هو نفسه كما لو تم تنفيذه في Ruby:

/*
 *  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: يتيح لك استبدال اسم الطريقة والمعلمات بنص اختيارك ، وهو أمر مفيد جدًا لطرق الفصل. يوضح أيضًا كيف يمكنك عرض رمز المثال في خط أحادي عن طريق المسافة البادئة ، على غرار تخفيض الطلب.

Answer 2

حيث تم تقاعد Rubyforge, ، إليك رابط جديد:

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