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

Статья
11/05/2008

Обновлен: Ноябрь 2007

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

Параметры

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

Дополнительные сведения о создании cref-ссылки на универсальный тип см. в разделе <see> (руководство по программированию на C#).
description
Описание исключения.

Заметки

Тег <exception> служит для указания возможных исключений. Этот тег может применяться к определениям методов, свойств, событий и индексаторов.

Чтобы обработать и сохранить комментарии документации в файл, при компиляции необходимо использовать параметр /doc.

Пример

// 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#

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