<exception> (Руководство по программированию на C#)

Статья
02/20/2013

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

Параметры

cref = " member"
Ссылка на исключение, которое доступно из текущей среды компиляции.Компилятор проверяет, существует ли исключение и приводит member к каноническому имени элемента в выходных XML-данных.member необходимо заключать в двойные кавычки (" ").

Дополнительные сведения о создании cref-ссылки на универсальный тип см. в разделе <see> (Руководство по программированию на 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#

Поделиться через