الدرس الواحد والسبعون - XML Commenting - نسخة قابلة للطباعة +- منتدى فيجوال بيسك لكل العرب | منتدى المبرمجين العرب (http://vb4arb.com/vb) +-- قسم : الأقسام التعليمية - المنتدى القديم (http://vb4arb.com/vb/forumdisplay.php?fid=90) +--- قسم : قسم دورات المنتدى (http://vb4arb.com/vb/forumdisplay.php?fid=113) +---- قسم : دورة .net 2008 . لنبدأ سوياً (http://vb4arb.com/vb/forumdisplay.php?fid=138) +---- الموضوع : الدرس الواحد والسبعون - XML Commenting (/showthread.php?tid=5669) |
الدرس الواحد والسبعون - XML Commenting - RaggiTech - 14-10-12 كاتب الموضوع : أحمد جمال
بسم الله الرحمن الرحيم .السلام عليكم ورحمة الله وبركاته . بما أن دروسنا في مجال التطبيقات العامة تقريباً انتهى ، وقبل البدء في عالم ASP.net سنراجع على عدة دروس سريعة ، درسنا اليوم حول ما يعرف باسم XML Commenting . بالواقع فإن عمل Comments للأكواد يعد أمراً في غاية الأهمية خصوصاً في حالة المشاريع الكبيرة ، حيث تستطيع مراقبة كودك كما يستطيع اي شخص آخر بقليل من الجهد معرفة كودك والاكمال عليه حتى ولو بعد توقفك عن العمل في نفس الكود بفترة طويلة جداً . وكما عرفنا في بدايات هذه الدروس ، يتم عمل ال Comment بالشكل التالي : C#: كود : // here we will do something, set x=startvalue كود : ' here we will do something, set x=startvalue *** من اوائل اللغات التي طبقت هذه الطريقة كانت Java من خلال javadoc . يتم ذلك بداية من خلال وضع /// ، بعد وضع هذه العلامة تستطيع وضع أي علامات خاصة بك للكود والذي سيتم التعامل مع لاحقاً على أن XML ما دام يطبق مبادئ XML ، هناك مجموعة من العناصر القياسية التي يفضل استخدامها لتوحيد المفاهيم . <c> : لتحديد ان اللاحق لا بد أن يعرض بخط مختلف <code> : لتحديد ان اتعدد الاسطر سيتم التعامل مع ككود <example> : تحديد مثال لشرح الكود المكتوب <exception> : الملف الذي يحتوي على الاستثناءات والأخطاء التي يمكن ان تنتج عن هذا الكود أو الفئة <list> : ادراج قائمة جداول داخل ال Documentation <param> لشرح بارميتر معين <permission> وصف وسائل الحماية لجزء معين <remarks> خيارات ال Build <returns> وصف ناتج الدالة return; <see> رابط آخر لجزء آخر من ال Documentation <seealso> مثل السابق ، ولكن (انظر ايضاً) <summary> وصف اجمالي للجزء المشروح <value> لوصف خاصية معينة الدرس الواحد والسبعون - XML Commenting - RaggiTech - 14-10-12 والآن ، ما هي الفائدة التي ستجنيها إذا استخدمت هذه الطريقة بدلاً من الطريقة التقليدية ؟؟؟ أولاً ، جرب مثلاً كتابة ما يلي لفئة الموظفين مثلاً : C#: كود : /// <summary> كود : ''' <summary> هل لاحظت الفارق ، اصبح الكود يظهر واضحاً لباقي مبرمجي فريقك ، اليس كذلك ؟ الدرس الواحد والسبعون - XML Commenting - RaggiTech - 14-10-12 نقطة أخرى : Documentation . ايضاً ومن ضمن خيارات ال Build ، يمكنك اخراج Documentation كاملة لمشروعك اعتماداً على هذه الوسوم ، لذا من خصائص المشروع قم باختيار Build وقم باختيار انتاج ملف XML بالشكل التالي : جرب الوصول لهذا الملف الذي قمت باختياره ، ستجد شيئاً مثل هذا : نقطة ثالثة : Documenation 2 . للاسف لا يوفر Visual Studio 2008 اداة افتراضية لتحويل ال XML السابق لصيغة مفهومة ، لكن يمكن استخدام أداة مثل NDoc لتحويل الملف السابق إلى مثل هذه الصورة : كل هذا فقط من ال Comments . إلى هنا نكون قد انتهينا من محتويات هذا الدرس . والله الموفق ... والسلام عليكم ورحمة الله وبركاته . |