Etiqueta de documentación <exception>
La etiqueta <exception> le permite especificar qué excepciones se pueden producir. Esta etiqueta se aplica a una definición de método.
Sintaxis
/// <exception cref="member">description</exception>
Parámetros
member
Una referencia a una excepción que está disponible desde el entorno de compilación actual. Mediante reglas de búsqueda de nombres, el compilador comprueba si la excepción dada existe y traduce member al nombre de elemento canónico en la salida XML. El compilador emite una advertencia si no encuentra member.
Ponga el nombre entre comillas simples o dobles.
Para más información sobre cómo crear una referencia cref a un tipo genérico, consulte <see>.
description
Una descripción.
Comentarios
Compile con /doc para procesar los comentarios de documentación a un archivo.
El compilador de MSVC intentará resolver las referencias cref en un solo paso mediante los comentarios de documentación. Si usa las reglas de búsqueda de C++, cuando el compilador no encuentra algún símbolo el compilador se marca como no resuelto. Para obtener más información, vea <seealso>.
Ejemplo
// 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^) {
}
}
};