<exceção> (Guia de programação C#)

Artigo
08/04/2011

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

Parâmetros

cref = " member"
Uma referência a uma exceção que está disponível no ambiente de compilação atual. 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 (" ").

Para obter mais informações sobre como criar uma referência de cref para um tipo genérico, consulte <see> (Guia de programação C#).
description
Uma descrição da exceção.

Comentários

<exception> marca permite que você especifique quais exceções podem ser geradas. Essa marca pode ser aplicada às definições de métodos, propriedades, eventos e indexadores.

Compilar com /doc a comentários de documentação do processo para um arquivo.

Para obter mais informações sobre o tratamento de exceções, consulte Exceptions and Exception Handling (C# Programming Guide).

Exemplo

// 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)
        {
        }
    }
}

Consulte também

Referência

Conceitos

C# Programming Guide

Partilhar via