|
#1
|
||||
|
||||
الدرس الواحد والسبعون : XML Commenting - دورة .net 2008
بسم الله الرحمن الرحيم . السلام عليكم ورحمة الله وبركاته . بما أن دروسنا في مجال التطبيقات العامة تقريباً انتهى ، وقبل البدء في عالم ASP.net سنراجع على عدة دروس سريعة ، درسنا اليوم حول ما يعرف باسم XML Commenting . بالواقع فإن عمل Comments للأكواد يعد أمراً في غاية الأهمية خصوصاً في حالة المشاريع الكبيرة ، حيث تستطيع مراقبة كودك كما يستطيع اي شخص آخر بقليل من الجهد معرفة كودك والاكمال عليه حتى ولو بعد توقفك عن العمل في نفس الكود بفترة طويلة جداً . وكما عرفنا في بدايات هذه الدروس ، يتم عمل ال Comment بالشكل التالي : C#: كود PHP:
كود PHP:
*** من اوائل اللغات التي طبقت هذه الطريقة كانت **** من خلال ****doc . يتم ذلك بداية من خلال وضع /// ، بعد وضع هذه العلامة تستطيع وضع أي علامات خاصة بك للكود والذي سيتم التعامل مع لاحقاً على أن XML ما دام يطبق مبادئ XML ، هناك مجموعة من العناصر القياسية التي يفضل استخدامها لتوحيد المفاهيم . <c> : لتحديد ان اللاحق لا بد أن يعرض بخط مختلف <code> : لتحديد ان اتعدد الاسطر سيتم التعامل مع ككود <example> : تحديد مثال لشرح الكود المكتوب <exception> : الملف الذي يحتوي على الاستثناءات والأخطاء التي يمكن ان تنتج عن هذا الكود أو الفئة <list> : ادراج قائمة جداول داخل ال ********ation <param> لشرح بارميتر معين <permission> وصف وسائل الحماية لجزء معين <remarks> خيارات ال Build <returns> وصف ناتج الدالة return; <see> رابط آخر لجزء آخر من ال ********ation <seealso> مثل السابق ، ولكن (انظر ايضاً) <summary> وصف اجمالي للجزء المشروح <value> لوصف خاصية معينة والآن ، ما هي الفائدة التي ستجنيها إذا استخدمت هذه الطريقة بدلاً من الطريقة التقليدية ؟؟؟ أولاً ، جرب مثلاً كتابة ما يلي لفئة الموظفين مثلاً : C#: كود PHP:
كود PHP:
هل لاحظت الفارق ، اصبح الكود يظهر واضحاً لباقي مبرمجي فريقك ، اليس كذلك ؟ نقطة أخرى : ********ation . ايضاً ومن ضمن خيارات ال Build ، يمكنك اخراج ********ation كاملة لمشروعك اعتماداً على هذه الوسوم ، لذا من خصائص المشروع قم باختيار Build وقم باختيار انتاج ملف XML بالشكل التالي : جرب الوصول لهذا الملف الذي قمت باختياره ، ستجد شيئاً مثل هذا : نقطة ثالثة : Documenation 2 . للاسف لا يوفر Visual Studio 2008 اداة افتراضية لتحويل ال XML السابق لصيغة مفهومة ، لكن يمكن استخدام أداة مثل NDoc لتحويل الملف السابق إلى مثل هذه الصورة : كل هذا فقط من ال Comments . إلى هنا نكون قد انتهينا من محتويات هذا الدرس . والله الموفق ... والسلام عليكم ورحمة الله وبركاته .
|
|
|
المواضيع المتشابهه | ||||
الموضوع | كاتب الموضوع | المنتدى | مشاركات | آخر مشاركة |
الدرس الواحد والستون ADO.net - دورة .net 2008 | khaledbelal | دورة .NET 2008 من منتدى فيجوال بيسك للعرب | 1 | 05-03-2011 10:47 PM |
الدرس السابع والخمسون : Wpf 2d - دورة .net 2008 | khaledbelal | دورة .NET 2008 من منتدى فيجوال بيسك للعرب | 2 | 03-05-2010 06:57 PM |
الدرس الواحد والأربعون : Partial Methods دورة .net 2008 | khaledbelal | دورة .NET 2008 من منتدى فيجوال بيسك للعرب | 0 | 02-26-2010 04:14 PM |
الدرس الواحد والثلاثون : ال Generic دورة .net 2008 | khaledbelal | دورة .NET 2008 من منتدى فيجوال بيسك للعرب | 0 | 02-25-2010 02:30 PM |
الدرس الرابع عشر : this دورة .net 2008 | khaledbelal | دورة .NET 2008 من منتدى فيجوال بيسك للعرب | 0 | 02-19-2010 07:58 PM |