<param> (ارشادات برمجة C#)

<param name='name'>description</param>

المعلمات

• name
  اسم معلمة الأسلوب. ضع الاسم ضمن علامات اقتباس مزدوجة(" ").

• description
  وصف المعلمة.

ملاحظات

يجب أن يتم استخدام علامة <param>في التعليق على تعريف أسلوب لوصف إحدى المعلمات للأسلوب. للتوثيق معلمات متعددة، استخدم علامات متعددة <param>.

سيتم عرض نص للعلامة <param>في قائمة IntelliSense "مستعرض الكائنات" وفي تقرير تعليق ويب للتعليمات البرمجية.

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

مثال

// compile with: /doc:DocFileName.xml 

/// text for class TestClass
public class TestClass
{
    // Single parameter.
    /// <param name="Int1">Used to indicate status.</param>
    public static void DoWork(int Int1)
    {
    }

    // Multiple parameters.
    /// <param name="Int1">Used to indicate status.</param>
    /// <param name="Float1">Used to specify context.</param>
    public static void DoWork(int Int1, float Float1)
    {
    }

    /// text for Main
    static void Main()
    {
    }
}

راجع أيضًا:

المرجع

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

المبادئ

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