التنبيهات التالية ظهرت :
Warning [2] count(): Parameter must be an array or an object that implements Countable - Line: 864 - File: showthread.php PHP 7.4.33 (Linux)
File Line Function
/showthread.php 864 errorHandler->error



تقييم الموضوع :
  • 0 أصوات - بمعدل 0
  • 1
  • 2
  • 3
  • 4
  • 5
مقال- التوثيق في الدوت نت Documenting In .NET
#1
كاتب الموضوع : Islam Ibrahim

التوثيق في الدوت نت من الأمور التي يجب المطوِّرين إدراكها وإتقان استخدامها وذلك من أجل تقديم المعلومات الإرشادية لمستخدمي البرامج وكذلك المطوِّرين الآخرين, يمكنك أن تتخيل الجهد المبذول الذي قامت به Microsoft لتأليف MSDN, ومن الغباء أن تتوقع انه قد تمت كتابتها يدويا أي باستخدام أشخاص توكل إليهم هذه المهام, فإن لـ Microsoft أداوت تقوم بتحرير تلك الصفحات بشكل آلي أسهل وأكفأ مما تتصّور.



ومن المزايا لتقنية التوثيق في الدوت نت خصوصاً هو مجانيتها وسهولة استخدامها, بالإضافة إلى
الكفاءة والسرعة في العمل.

في هذا المقال مجموعة من المقالات الفرعية وسأضمنها تباعاَ, وهي:
  • Microsoft Sandcastle
  • CodePlex DocProject and Sandcastle help File Builder
  • Microsoft Assistance Markup Language (MAML)
  • مجموعة من الأمثلة

Microsoft Sandcastle
هي أداة مجانية من Microsoft لتوليد ملفات التوثيق والتي تأخذ شكل MSDN باستخدام تقنية Reflection على تجميعات .NET (.NET Assemblies) ومستندات التعليقات ذات التنسيق XML ((Comments Documentation XML والتي عادة ما تكون موجودة ضمن الملفات المصدر (Source Code), وبإمكانها كذلك توليد الوثائق التي تعتمد على Microsoft Assistance Markup Language (MAML).
تعتمد Microsoft Sandcastle على أدوات سطر الأوامر, ملفات التكوين, أدوات البناء, وملفات تحويل XSLT, والتي تعمل مجتمعة على تحويل الملفات التي تحتوي على التعليقات إلى ملفات التي ملفات المساعدة والتي يمكن عرضها ضمن نظام التعليمات.
لتحميل أحدث إصدار من Microsoft Sandcastle راجع موقع تنزيل Microsoft Sandcastle.

يحتوي Microsoft Sandcastle على العديد من البرامج نذكر منها:
MrefBuilder يقوم بإنشاء ملف بعد القيام بعملية Reflection على التحميع الممرر إليه.
XslTransform يقوم باستلام الملف المخرج من أداة MrefBuilder لتطبيق تحويلات XLS اللازمة إلى ملف XML
BuildAssembler يقوم بتوليد أدوات بناء مؤقتة وفق كل Topic, والتي يتم تعيينها في ملفات XML Maniest
لايقوم Samdcastle بإنشاء ملفات CHM مباشرة وإنما يقوم فقط بتوليد ملفات HTML والبقية تتركها على المشاريع التي قام أعضاء موقع CodePlex بإنشائها.

وبسبب هذه الأدوات الكثيرة ونظرا لأنه فقط مجموعة من أدوات سطر الأوامر, فإنه يصعب استخدام Sandcastle بشكل مباشر لذلك تم إنشاء مجموعة من المشاريع ذات واجهة الاستخدام GUI من قبل CodePlex والتي تبسط العمل إلى حد كبير.
}}}
تم الشكر بواسطة:


الردود في هذا الموضوع
مقال- التوثيق في الدوت نت Documenting In .NET - بواسطة Raggi Tech - 09-10-12, 11:26 AM

المواضيع المحتمل أن تكون متشابهة .
الموضوع : الكاتب الردود : المشاهدات : آخر رد
  شاهد حداءة ( مقال الوحي يضحد كل قول وإن قال العظام العالمون ) مسوق اونلاين 0 362 23-08-22, 10:33 PM
آخر رد: مسوق اونلاين
  مقال: Reflection وكيفية استخدامها في برامجنا Islam Ibrahim 5 3,238 13-01-16, 11:41 PM
آخر رد: Fantastico
  [مقال منقول] مشروع Mono : شغل الدوت نت على اللينكس أو أي نظام تشغيل تحلم به الشاكي لله 6 5,448 13-03-14, 02:02 AM
آخر رد: الشاكي لله
  بشرى! دوت نت عربي- DotNetArabi لقاءات صوتية مع مبرمجين محترفين في الدوت نت RaggiTech 0 2,035 27-10-12, 04:50 PM
آخر رد: RaggiTech
  كيف تحصل علي إصدار الدوت الموجود علي جهاز الكمبيوتر RaggiTech 2 2,415 27-10-12, 04:31 PM
آخر رد: RaggiTech
  مقال- كيف نحل مشاكلنا بأنفسنا- RaggiTech 0 2,181 27-10-12, 04:23 PM
آخر رد: RaggiTech
  كيف تحصل علي إصدار الدوت الموجود علي جهاز الكمبيوتر RaggiTech 0 1,793 09-10-12, 05:47 PM
آخر رد: RaggiTech
  كيفيه اداره الاحداث فى بيئه الدوت نت الجزء الثالث how To Handle Events in.net Part 3 RaggiTech 0 1,955 09-10-12, 05:22 PM
آخر رد: RaggiTech
  كيفيه اداره الاحداث فى بيئه الدوت نت الجزء الثانى how To Handle Events in .net Part 2 RaggiTech 0 1,963 09-10-12, 05:21 PM
آخر رد: RaggiTech
  كيفيه اداره الاحداث فى بيئه الدوت نت الجزء الاول part 1 how to Handle Events in .net RaggiTech 0 1,848 09-10-12, 05:20 PM
آخر رد: RaggiTech

التنقل السريع :


يقوم بقرائة الموضوع: بالاضافة الى ( 1 ) ضيف كريم