كيفية الحصول على الرسم البياني مكالمات كاملة لأغراض الوثائق؟

StackOverflow https://stackoverflow.com/questions/3260228

سؤال

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

وأنا أعلم أنه غير ضروري تماما، لكن في بعض الأحيان نجد أنفسنا في هذه الحالات ولا يمكن أن يفعل الكثير عن ذلك: -).

أساسا أحتاج إلى مولد الرسم البياني ل Java Call، وأعتقد أن السبب في أنني لا أستطيع العثور على واحدة لأن الوظائف الافتراضية تمنع التحليل الثابت؟

هل كانت مفيدة؟

المحلول

أوصي بشدة Doxygen .

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

تحقق من الأمثلة والضخمة قائمة المشاريع التي تستخدم doxygen .

أنا شخصيا لن أستخدم أي شيء آخر وأصر على أن جميع التعليمات البرمجية المكتوبة في شركتي تستخدم Doxygen.

edit: p.s doxygenis مفيد جدا، حتى على التعليمات البرمجية غير المطولة أنها الأداة الأولى التي أبحث عنها عندما ترث رمز إرث شخص آخر.لا شيء آخر يعطيني مثل هذه نظرة عامة جيدة بسرعة.

نصائح أخرى

ليس حل دقيق لمشكلتك، وشراء يمكنك استخدام API DoClet واكتب DoClet الخاص بك.يمكنك الوصول إلى طرق مع وسيطاتها وأنواع عودتهم وأكثر من ذلك بكثير.عندما تذهب بهذه الطريقة، يمكنك أيضا الاستيلاء على تعليقات طريقة لأغراض الوثائق.

مرخصة بموجب: CC-BY-SA مع الإسناد
لا تنتمي إلى StackOverflow
scroll top