الوثائق التلقائية - أفضل طريقة لإنشاء محلل سريع

Question

لدي برنامج نصي كبير يحتاج المستخدمون النهائيون إلى تحريره بحيث يتطلب تعليقا ضروريا إلى حد ما. يمكنني استخدام تخطيط لملفي مشابه لهذا

//********************
//
// FileName
//    This script contains:
//    - Function X - does something
//    - Function Y - does something else
//
//********************

//********************
// Function X
// does something (<< I'd only like to enter this part once)
//********************
// Code here...

//********************
// Function Y
// does something else
//********************
// Code here...

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

Answer 1

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

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