كيف يمكنني توثيق طرق ضمنية داخل نماذج القضبان؟

Question

أنا استخدم حديقة منزل في مشروع Rails الخاص بي وكنت أتساءل كيف سأقوم بتوثيق أساليب وقت التشغيل الموروثة على نموذج القضبان؟ على سبيل المثال توثيق وجود أ first_name ميزة على أ User نموذج.

Answer 1

لا يمكنك فعل ذلك ، IMHO.

المشكلة هي أن هذه الأساليب لا توجد حقًا "موجودة" ؛ يتم "إنشائها على الذبابة" عبر method_missing السنانير ، في المرة الأولى التي يتم فيها استدعاء ، في وقت التشغيل.

أنظمة توليد الوثائق الأخرى لديها طرق لإعلان الأساليب "الضمنية". على سبيل المثال ، لدى NaturalDocs ملف الكلمة الرئيسية وظيفة يتيح لك ذلك إنشاء وظائف موجودة فقط على التعليقات. لست على دراية بما فيه الكفاية مع الفناء ، لكن يبدو أنه ليس لديه وظيفة مماثلة.

حظا طيبا وفقك الله!