ما هو الفرق بين RI و RDOC

Question

كلما قمت بتثبيت الأحجار الكريمة ، أرى RI و RDOC يتبعان. أعلم أن هذا وثائق ولكن ما هو الفرق بين الاثنين وكيفية استخدامهما؟

Answer 1

RDOC [..] هو مولد الوثائق المدمجة للغة برمجة Ruby. [..] يتم تضمين RDOC كجزء من توزيع Ruby Core.

يوفر RDOC أيضًا المحرك لإنشاء ملفات بيانات Ruby RI. RI هي (أكثر أو أقل) نسخة Ruby من صفحات MAN ، تقدم معلومات API من سطر الأوامر.

من:http://en.wikipedia.org/wiki/rdoc

Answer 2

للوصول إلى RDOC المحلي لأحجار الكواهر الخاصة بك ، اكتب gem server وتوجه متصفحك إلى http://localhost:8808.

إذا لم يتم تثبيت RDOCs للأحجار الكريمة الخاصة بك ، gem rdoc --allسيتم تثبيت الوثائق لجميع الأحجار الكريمة.

قد يبدو أن الوثائق المحلية ليست ضرورية. يتخطى العديد من المطورين تثبيته عن قصد لصالح الوثائق عبر الإنترنت. ومع ذلك ، بالنسبة لأولئك منا الذين يستخدمون الأدوات القديمة مثل Rails 2 ، يمكن أن يجعل العثور على الوثائق الصحيحة سريعة وسهلة.

Answer 3

• RDoc يقوم تلقائيًا بإنشاء وثائق من تعليقات وبنية التعليمات البرمجية الخاصة بك. https://github.com/rdoc/rdoc لذلك فكر في doxygen. استخدمه لإنشاء وثائق تلقائية للرمز الذي كتبته.
• ri هو ملفات مساعدة غير متصلة بالإنترنت على سبيل المثال إذا لم يكن لديك الإنترنت. http://www.caliban.org/ruby/rubyguide.shtml#ri فكر في perldoc. استخدمه عندما يكون لديك سؤال حول الفصل ، مثل ri Enumerator يجب أن تطرح

العداد <كائن

---

= يشمل: enumeries (من Ruby Core)

(من Ruby Core) --------------------------------------- ------------------------------- فئة تسمح بالتكرار الداخلي والخارجي.

يمكن إنشاء العداد بالطرق التالية. * kernel#to_enum * kernel#enum_for * enumerator.new

تحتوي معظم الطرق على نموذجين: نموذج كتلة حيث يتم تقييم المحتويات لكل عنصر في التعداد ، وشكل غير متميز يرجع العداد الجديد يلف التكرار.

enumerator = ٪ w (واحد اثنان ثلاثة). EACH يضع enumerator.class # => enumerator enumerator.each_with_object ("foo") do | item ، obj | يضع " # {obj}: # {item}" end # foo: one # foo: two # foo: three enum_with_obj = enumerator.each_with_object ( OBJ | يضع " # {obj: # {item}" end # foo: One # foo: two # foo: three

هذا يتيح لك سلسلة التعداد معا ........