Marca de documentação <exception>
A marca <exception> permite que você especifique quais exceções podem ser lançadas. Essa marcação é aplicada a uma definição de método.
Sintaxe
/// <exception cref="member">description</exception>
Parâmetros
member
Uma referência a uma exceção que está disponível no ambiente de compilação atual. Usando as regras da pesquisa de nome, o compilador verifica se a exceção fornecida existe e converte member no nome de elemento canônico no XML de saída. O compilador emite um aviso se não encontrar member.
Coloque o nome entre aspas simples ou duplas.
Para obter mais informações sobre como criar uma referência cref para um tipo genérico, confira <see>.
description
Uma descrição.
Comentários
Compile com /doc para processar comentários de documentação em um arquivo.
O compilador do MSVC tenta resolver as referências cref em uma passagem pelos comentários da documentação. Se você estiver usando as regras de pesquisa do C++, quando um símbolo não for encontrado pelo compilador, a referência será marcada como não resolvida. Para obter mais informações, consulte <seealso>.
Exemplo
// xml_exception_tag.cpp
// compile with: /clr /doc /LD
// post-build command: xdcmake xml_exception_tag.dll
using namespace System;
/// Text for class EClass.
public ref class EClass : public Exception {
// class definition ...
};
/// <exception cref="System.Exception">Thrown when... .</exception>
public ref class TestClass {
void Test() {
try {
}
catch(EClass^) {
}
}
};