RDoc
RDoc ، من تصميم ديف توماس ، هو مولد توثيق مدمج للغة البرمجة روبي . يقوم بتحليل شفرة روبي المصدرية ، مُنشئًا مجموعة مُهيكلة من الصفحات لكائنات روبي ووظائفها . يُمكن إضافة تعليقات الشفرة بأسلوب طبيعي. RDoc مُضمن كجزء من توزيعة روبي الأساسية. يُعد برنامج RDoc وتنسيقه امتدادًا لتنسيق مستندات روبي (مع البرنامج المُصاحب RD).
يُمكن لـ RDoc إنتاج وثائق قابلة للاستخدام حتى لو لم يحتوي كود المصدر المستهدف على تعليقات صريحة ، حيث سيقوم بتحليل الفئات والوحدات والأساليب ، وإدراجها في ملفات واجهة برمجة التطبيقات (API) المُنشأة . كما يُوفر RDoc محركًا لإنشاء ملفات بيانات Ruby ri، مما يُتيح الوصول إلى معلومات واجهة برمجة التطبيقات من سطر الأوامر .
يتولى إريك هودل وريان ديفيس حاليًا صيانة RDoc و ri.
بناء الجملة
يدعم RDoc أربع لغات ترميز: RDoc Markup و Markdown و tomdoc و rdtool. ويُستخدم RDoc Markup الخاص به افتراضيًا. في RDoc Markup، تُحاط التوجيهات الخاصة بنقطتين رأسيتين. على سبيل المثال، للإشارة إلى أن دالة ما تأخذ وسيطين يُسميان siteو article، يمكن كتابة :args: site, article. [ 1 ]
انظر أيضاً
مراجع
- ↑ "class RDoc::Markup" . rdoc 6.0.4 Documentation .
روابط خارجية
- مولدات الوثائق المجانية
- برنامج مجاني مكتوب بلغة روبي
- برنامج يستخدم رخصة جنو العمومية العامة
- برامج مجانية متعددة المنصات
- نماذج أولية لبرامج مجانية ومفتوحة المصدر