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


<exception> (Visual Basic)

Задает, какие исключения могут возникнуть.

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

Параметры

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

  • description
    Описание

Заметки

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

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

Пример

В этом примере используется тег <exception> для описания исключения, которое может создавать функция IntDivide.

''' <exception cref="System.OverflowException">
''' Thrown when <paramref name="denominator"/><c> = 0</c>.
''' </exception>
Public Function IntDivide( 
        ByVal numerator As Integer, 
        ByVal denominator As Integer 
) As Integer
    Return numerator \ denominator
End Function

См. также

Ссылки

Рекомендуется использовать XML-теги для комментариев документации (Visual Basic)