<list> (دليل البرمجة لـ #C)

<list type="bullet" | "number" | "table">
    <listheader>
        <term>term</term>
        <description>description</description>
    </listheader>
    <item>
        <term>term</term>
        <description>description</description>
    </item>
</list>

المعلمات

• term
  مصطلح للتعريف, سيتم تعريفه في description.

• description
  إما عنصر ما في تعداد نقطي أو قائمة مرقمة أو تعريف term.

ملاحظات

يتم استخدام كتلة <listheader> لتعريف صف الرأس لجدول أو لقائمة تعريفات. عند تعريف جدول, تحتاج فقط لتوفير إدخال مصطلح في العنوان.

يتم تحديد كل عنصر في القائمة بكتلة <item>. عند إنشاء قائمة تعريفات، ستحتاج إلى تحديد كلاً من term و description. ومع ذلك، للجدول أو للقائمة ذات التعداد النقطي أو للقائمة المرقمة, تحتاج فقط لتوفير إدخال لـ description.

يمكن للقائمة أو للجدول أن يكون لديها عدد من كتل <item> حسب الحاجة.

قم بالترجمة مع /doc لمعالجة تعليقات الوثائق للملف.

مثال

// compile with: /doc:DocFileName.xml 

/// text for class TestClass
public class TestClass
{
    /// <summary>Here is an example of a bulleted list:
    /// <list type="bullet">
    /// <item>
    /// <description>Item 1.</description>
    /// </item>
    /// <item>
    /// <description>Item 2.</description>
    /// </item>
    /// </list>
    /// </summary>
    static void Main()
    {
    }
}

راجع أيضًا:

المرجع

العلامات المطلوبة لتعليقات الوثائق (دليل برمجة C#)

المبادئ

دليل البرمجة لـ #C