<exception> (Guia de Programação em C#)
<exception cref="member">description</exception>
Parâmetros
cref = " member"
Uma referência a uma exceção que está disponível a partir do atual ambiente de compilação. 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 em C#).
description
Uma descrição da exceção.
Comentários
O <exception> marca permite especificar quais exceções podem ser geradas. Essa marca pode ser aplicada às definições de métodos, propriedades, indexadores e eventos.
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 Exceções e manipulação de exceções (Guia de Programação em C#).
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
Marcas recomendadas para comentários de documentação (Guia de Programação em C#)