<exception> (Visual Basic)

  • Artículo

Especifica qué excepciones se pueden producir.

Sintaxis

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

Parámetros

member
Una referencia a una excepción que está disponible desde el entorno de compilación actual. El compilador comprueba si la excepción dada existe y traduce member al nombre de elemento canónico en la salida XML. member debe aparecer entre comillas dobles (" ").

description
Una descripción.

Comentarios

Use la etiqueta <exception> para especificar qué excepciones se pueden producir. Esta etiqueta se aplica a una definición de método.

Compile con -doc para procesar los comentarios de documentación de un archivo.

Ejemplo

En este ejemplo se usa la etiqueta <exception> para describir una excepción que la función IntDivide puede producir.

''' <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 también