<exception> (Visual Basic)

  • Artigo

Especifica quais exceções podem ser geradas.

Sintaxe

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

Parâmetros

member
Uma referência a uma exceção que está disponível no ambiente de compilação atual. O compilador verifica se a exceção apresentada existe e move o member para o nome de elemento canônico no XML de saída. member deve ser exibido entre aspas duplas (" ").

description
Uma descrição.

Comentários

Use a marca <exception> para especificar quais exceções podem ser geradas. Essa marcação é aplicada a uma definição de método.

Compile com -doc para processar comentários de documentação em um arquivo.

Exemplo

Este exemplo usa a marca <exception> para descrever uma exceção que a função IntDivide pode gerar.

''' <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

Confira também