<exception> (Visual Basic)

Especifica las excepciones que se pueden producir.

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

Parámetros

  • member
    Referencia a una excepción disponible desde el entorno de compilación actual.El compilador comprueba que la excepción proporcionada existe y traduce member al nombre de elemento canónico en el resultado XML.member debe aparecer entre comillas dobles ("").

  • description
    Descripción.

Comentarios

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

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

Ejemplo

Este ejemplo utiliza la etiqueta <exception> para describir una excepción que puede producir la función 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

Vea también

Referencia

Etiquetas XML recomendadas para comentarios de documentación (Visual Basic)