وثيقة روبي يارد لا تظهر أي ملفات
سؤال
هذا هو الإعداد الخاص بي:
- روبي 1.9.2 ص290
- ساحة 0.8.1
بنية المجلد ليست جوهرة، بل مجرد كود روبي قديم:
.
├── classes
│ ├── crawl.rb
│ └── page.rb
└── run.rb
المشكلة هي أن الفناء لا يرى أي ملفات.
yard doc
ينتج هذا الإخراج:
Files: 0
Modules: 0 ( 0 undocumented)
Classes: 0 ( 0 undocumented)
Constants: 0 ( 0 undocumented)
Methods: 0 ( 0 undocumented)
0.00% documented
أي أفكار لماذا لا يستطيع رؤية أي من ملفاتي، أو لا
تحرير (معلومات إضافية):
لدى Yard أذونات لإنشاء الملفات.
بعد أن أقوم بتشغيل yard doc
الأمر، يعرض الدليل الخاص بي ملفات الفناء:
. .. .yardoc classes doc run.rb
تحرير (الرد على التعليق حول rdoc)
بمجرد أن أحذف مجلد المستند الذي أنشأته الساحة (يشكو rdoc منه) rm -rf doc
, ، يقوم rdoc بإنشاء الوثائق وتوفير هذا الإخراج
Files: 7
Classes: 6 ( 4 undocumented)
Modules: 0 ( 0 undocumented)
Constants: 2 ( 2 undocumented)
Attributes: 18 (18 undocumented)
Methods: 24 (20 undocumented)
Total: 50 (44 undocumented)
12.00% documented
تحرير (معلومات إضافية)
لا يعمل Yard بالنسبة لي على إصدارات روبي الأخرى بما في ذلك MRI 1.8.7 وjRuby 1.6.4.يتصرف بنفس الطريقة الموضحة أعلاه
المحلول
لا يقوم Yard بتوثيق جميع ملفات روبي تلقائيًا في بنية الدليل.يبحث عن الملفات في ملف ./lib
الدليل.إذا كنت تريد توثيق الآخرين، فيجب عليك تحديد ذلك في الأمر أو في ملف .yardopts
مثالyard classes/*.rb *.rb