Compartilhar via


<exceção>(Guia de programação translation from VPE for Csharp)

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

Parâmetros

  • cref = "member"
    Uma referência a uma exceção está disponível no ambiente de compilação corrente.O compilador verifica se a exceção apresentada existe e se traduz member ao nome canônico do elemento na saída XML. memberdeve aparecer entre aspas duplas ("").

    Para obter mais informações sobre como criar uma referência cref para um tipo genérico, consulte <see>(Guia de programação translation from VPE for Csharp).

  • description
    Uma descrição da exceção.

Comentários

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

Compilar com /doc para processar documentação comentários em um arquivo.

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

Conceitos

Guia de Programação C#

Referência

Recomendado Rótulos de comentários de documentação (guia de programação translation from VPE for Csharp)