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

<exception cref="member">description</exception>

المعلمات

  • cref = " member"
    مرجع إلى استثناء توفر من بيئة الترجمة الحالية. يتحقق المحول البرمجي من وجود الاستثناء ويقوم بترجمة member إلى اسم العنصر المقبول في إخراج XML . member يجب أن يظهر بين علامتي اقتباس مزدوجة (" ").

    للحصول على معلومات أكثر حول كيفية إنشاء مرجع cref لنوع عام، راجع دليل البرمجة لـ #C.

  • description
    وصف الاستثناء.

ملاحظات

تتيح لك علامة <exception> تحديد أي الاستثناءات يمكن طرحها. يمكن تطبيق هذه العلامة على تعريفات الأساليب والخصائص والأحداث والمفهرسات.

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

للحصول على معلومات أكثر حول معالجة الاستثناء، راجع استثناءات ومعالجة ‏‏ استثناء (البرمجة C# إرشادات).

مثال

// compile with: /doc:DocFileName.xml 

/// comment for class
public class EClass : System.Exception
{
    // class definition...
}

/// comment for class
class TestClass
{
    /// <exception cref="System.Exception">Thrown when...</exception>
    public void DoSomething()
    {
        try
        {
        }
        catch (EClass)
        {
        }
    }
}

راجع أيضًا:

المرجع

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

المبادئ

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