09-10-12, 11:26 AM
كاتب الموضوع : 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 والتي تبسط العمل إلى حد كبير.