<exception> (Visual Basic)

Especifica quais exceções podem ser geradas.

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

Parâmetros

  • member
    Uma referência a uma exceção que está disponível a partir do atual ambiente de compilação.O compilador verifica se a exceção apresentada existe e se traduz member para o nome do elemento canônico na saída XML.memberdeve aparecer entre aspas duplas ("").

  • description
    Uma descrição.

Comentários

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

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

Exemplo

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

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

Consulte também

Referência

Recomendado marcas XML para comentários da documentação (Visual Basic)