ما هي أسرع طريقة للوصول إلى وثائق روبي؟[مغلق]

Question

لنفترض أنني أكتب بعض رموز روبي وأريد استخدام نوع التاريخ القياسي للحصول على التاريخ الحالي.بدلاً من استخدام محرك بحث، هل هناك طريقة أسرع للعثور على الوثائق الخاصة بهذا الفصل؟أعلم أنه يمكنني الحصول على طرق التاريخ عن طريق الكتابة Date.methods, ، ولكن على حد علمي لا يوفر هذا تفاصيل حول أنواع الوسائط أو قيمة الإرجاع.

نرحب بالإجابات الخاصة بالمحرر.المحرر المفضل لدي هو Emacs.

Answer 1

المرجعية مستندات روبي الأساسية

استخدم أمر البحث عن النص في متصفح الويب الخاص بك.

قد يبدو الأمر غير متوقع، إلا أنني أجد أن هذا في الواقع أسرع من الاستخدام ri, ، والتي يبدو لسبب ما أنها تستغرق وقتًا طويلاً لبدء التشغيل.

كما أنها أفضل بكثير من ri لأن صفحة HTML تسرد كافة الوثائق لجميع الأساليب في صفحة واحدة.في كثير من الأحيان ترتبط الطرق بالآخرين، ويتم التبديل بين 2 riإنه أمر مؤلم

Answer 2

على وحدة التحكم الخاصة بك، استخدم "ri"

ri Date

وهذا يعمل مع جميع الطبقات.(على سبيل المثالسلسلة RI) لرؤية وثائق لطريقة معينة تستخدمها هذا:

ri Date#yourMethod

Answer 3

المصدر الأساسي لتوثيق روبي هو روبي وثيقة - الرابطان الأكثر أهمية هما جوهر و مكتبة قياسية.تحصل على تمثيل بنمط javadoc والذي يغطي عادةً أنواع الوسائط وقيم الإرجاع.يمكنك حتى أن تصنعها بنفسك ردوك.

Answer 4

لأولئك منكم الذين يريدون المستندات من داخل Vanilla IRB

1. يتبع هؤلاء تعليمات لإعداد وثائق RI الأساسية.حتى كتابة هذه السطور، الخطوات هي

   $ cd ~/.rvm/src
   $ rvm docs generate-ri
   

2. يمكنك الآن عرض المستندات الخاصة بطريقة محددة في سطر الأوامر باستخدام الملف ri يأمر.لاستدعائه من داخل IRB، استخدم أمر المساعدة:

   $ irb
   irb(main):001:0> help 'String#chomp'