التوثيق الآلي لبرامج جافا

الملخص AR

تؤدي عمليات التوثيق دورا كبيرا في تطوير الأنظمة البرمجية و صيانتها، إذ تعد هذه العمليات سمة مهمة لكل مشاريع البرمجيات و البرامج على نحو عام.

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

يتعلق البحث ببناء أداة توثيق آلية (Auto Documentation Tool) ADT تستخدم في توثيق شفرة المصدر للبرامج المكتوبة بلغة جافا في الأنظمة القديمة (Legacy systems) و لا سيما لبرامج على نحو عام و التي لا تحتوي على توثيق أو إعادة توثيق هذه الأنظمة بشكل متقن، و قد تم تمثيل ناتج عمليات التوثيق هذه إما على شكل مخطط الصنف ( Class Diagram) باستخدام لغة النمذجة الموحدة (Unified Modeling Language) UML أو بشكل نصي سهل الفهم باستخدام لغة التوصيف الموسعة (Extensible Markup Language) XML.