صيانة مكررة - الكود والوثائق [مغلق]

Question

قد لا يكون هذا هو العنوان الأفضل - وسأكون ممتنًا إذا توصل شخص ما إلى عنوان أفضل بعد قراءة مشكلتي.أيضًا، أريد أن أقول مقدمًا إنني علمت نفسي إلى حد كبير على الإنترنت، لذلك قد يكون هناك العديد من الأدوات التي لست على علم بها.

أقوم بصيانة برنامج يطبق مفهوم البرمجة المستندة إلى التدفق (FBP) في كل من Java وC#.لكل من هذه، لدي رمز على:

• موقع الويب الخاص بي
• نظام إصدار الملفات SourceForge (ملفات مضغوطة أو ملفات jar)
• سورس فورج SVN

بالإضافة إلى ذلك، لدي مراجع للإصدار وأوصاف (جزئية في بعض الأحيان) حول:

• موقع الويب الخاص بي (HTML)
• الويكي الخاص بي
• جافادوك

هناك أيضًا أداة رسم، موجودة أيضًا على موقع الويب الخاص بي وSourceForge، والتي يجب أن تعرف أحدث إصدار من إصدار Java من كود FBP.

كل شيء مترابط تمامًا، لكن في بعض الأحيان أفتقد مرجعًا!منذ بضعة أيام، أدركت أنني لم أقم بتحديث SourceForge News لمشروعي منذ فترة طويلة، لذلك كان علي أن أسارع إلى القيام بذلك :-)

أدرك أن بعض هذه المركبات ربما تكون زائدة عن الحاجة، لكن بشكل عام، لا أعرف من يراقب ماذا.

لذا فإن سؤالي هو ما إذا كانت هناك طريقة لتقليل كل هذه النفقات العامة، على سبيل المثال.ستكون وظيفة HTML "imbed" أمرًا رائعًا، لذا يمكنني على الأقل تخزين رقم الإصدار الأحدث في مكان واحد.ربما يمكنني تبسيط المراجع الترافقية لـ Java، لكن اللغات البينية ستكون أجمل، ولكن من غير المحتمل، على ما أعتقد.

كل الأفكار مرحب بها.

Answer 1

يبدو لي أنك تريد تحديث وثائقك وصيانتها كجزء من عملية الإنشاء/النشر، على سبيل المثال.

1. يبني
2. اختبار الوحدة الخ
3. تجميع الوثائق
4. نشر البنيات
5. نشر الوثائق المجمعة

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

لست متأكدًا من وجود علاج سحري لكل هذا.أحتفظ بأرقام الإصدارات في ملفات الخصائص/ملفات التكوين، وأقوم بالبحث/الاستبدالات المناسبة.يتم إدخال وثائق التعليمات البرمجية حيثما أمكن ذلك في التعليمات البرمجية نفسها، ثم تتم معالجتها مسبقًا في الإصدار الخاص بي (الخطوة 3 أعلاه).

هل رأيت / استخدمت دوكسيجين ؟سيتعامل ذلك مع متطلباتك المتعددة اللغات، وهو راسخ لبناء/صيانة الوثائق.

Answer 2

يبدو أنك بحاجة إلى أتمتة عملية الإنشاء/النشر.قرأت هذا المقال على أورايلي منذ فترة - يبدو أنكما تواجهان مواقف متشابهة إلى حد ما؟يستخدم حله لغة بايثون بكثافة، ولكن على الأقل قد يمنحك بعض الأفكار.