Compartir a través de

<exception> (Guía de programación de C#)

  • Artículo

Actualización: noviembre 2007

<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 si existe la excepción dada y convierte 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.

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

Conceptos

Guía de programación de C#

Referencia

Etiquetas recomendadas para comentarios de documentación (Guía de programación de C#)