طريقة لعمل وثائق لبرنامجك

الآن وقبل تعريف الكلاس أضف ثلاث ' ثم انقر enter كما في صورة

فيظهر لك بلوك التعليق الأساسي كما في الصورة

الان أدخل المعلومات كما في الصورة لتكملة التعليقات المناسبة

وبذلك نكون قد انتهينا من إضافة التعليقات الخاصة بتعريف الكلاس وبقي إضافة التعليقات الخاصة بالإجراء

الآن وبنفس الطريقة أدخل التعليقات الخاصة بالإجرائين كالكود

    ''' -----------------------------------------------------------------------------
    ''' <summary>
    ''' This test fucntion is to add numbers and return The result
    ''' </summary>
    ''' <param name="N1">First number it has an integer Value</param>
    ''' <param name="N2">Second number it has an integer Value</param>
    ''' <returns>A sum of two numbers as an integer value</returns>
    ''' <example>
    ''' <code>Dim Ret As Integer = AssNumbers(150,453)</code>
    ''' </example>
    ''' <history>
    '''  [msas]	15/07/2005	Created
    ''' </history>
    ''' -----------------------------------------------------------------------------
    Public Function AddNumbers(ByVal N1 As Integer, ByVal N2 As Integer) As Integer
        Return N1 + N2
    End Function

    ''' -----------------------------------------------------------------------------
    ''' <summary>
    ''' This test fucntion is to substract numbers and return The result
    ''' </summary>
    ''' <param name="N1">First number it has an integer Value</param>
    ''' <param name="N2">Second number it has an integer Value</param>
    ''' <returns>A sum of two numbers as an integer value</returns>
    ''' <example>
    ''' <code>Dim Ret as Integer = SubstractNumbers(550,250)</code>
    ''' </example>
    ''' <history>
    '''  [msas]	15/07/2005	Created
    ''' </history>
    ''' -----------------------------------------------------------------------------
    Public Function SubstractNumbers(ByVal N1 As Integer, ByVal N2 As Integer) As Integer
        Return N1 - N2
    End Function

ثم قم بترجمة المشروع

بارك الله فيك

علما بأن بلوكات التعليقات المستخدمة هي

<c> 
<para> 
<see> 
<code> 
<param> 
<seealso> 
<example> 
<paramref> 
<summary> 
<exception> 
<permission> 
<value> 
<include> 
<remarks> 
<list> 
<returns>

ويمكنك معرفة خصائصها بالتفصيل من الرابط

هنا

شكرا لك أخ SOLO.NET على الرد ولكني متابع حديثي

وانا متابع معك اخ محمد

الآن أغلق بيئة التطوير وافتح برنامج NDOC لإنشاء الوثائق اضغط زر ADD ثم اختر ناتج ترجمة المشروع الخاص بك ClassLibrary2.dll مثلا كما في الصورة

اضغط OK ثم زر Build كما في الصورة

وبعد انتهاء عملية الترجمة سيكون عملنا قد انتهى

بقيت لدي ملاحظة أخيرة وأكون قد انتهيت إذا كنت قد استخدمت تعليقات باللغة العربية يجب عليك تبديل Lang ID إلى 1025 من خيارات برنامج NDOC حتى تظهر التعليقات بالشكل الصحيح كما في الصورة

ومرفق المثال الخاص بي مع الوثائق الناتجة

وبهذا أكون قد انتهيت من حديثي حول توثيق برامجك وسأحاول الإجابة قدر الإمكان على أي سؤال بخصوص هذا الموضوع

وهذا رابط لنفس الموضوع من موقع مايكروسوفت باللغة الإنكليزية لمن يحب الإطلاع وحرصا على ألا أكون قد نسيت أي معلومة مفيدة

الرابط هنا

Documents Example.zip