<exception> (Guía de programación de C#)
<exception cref="member">description</exception>
Parámetros
cref = "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 ("").Para obtener más información sobre cómo crear una referencia cref a un tipo genérico, vea <see> (Guía de programación de C#).
description
Descripción de la excepción.
Comentarios
La etiqueta <exception> permite especificar las excepciones que se pueden producir. Esta etiqueta puede aplicarse a las definiciones de métodos, propiedades, eventos e indizadores.
Compile con el parámetro /doc para procesar los comentarios de documentación y generar un archivo con ellos.
Para obtener más información acerca del control de excepciones,vea Excepciones y control de excepciones (Guía de programación de C#).
Ejemplo
// compile with: /doc:DocFileName.xml
/// Comment for class
public class EClass : System.Exception
{
// class definition...
}
/// Comment for class
class TestClass
{
/// <exception cref="System.Exception">Thrown when...</exception>
public void DoSomething()
{
try
{
}
catch (EClass)
{
}
}
}
Vea también
Referencia
Etiquetas recomendadas para comentarios de documentación (Guía de programación de C#)