<exception> Dokumentationstag
Mit dem Tag <exception> können Sie angeben, welche Ausnahmen ausgelöst werden können. Dieses Tag wird auf eine Methodendefinition angewendet.
Syntax
/// <exception cref="member">description</exception>
Parameter
member
Ein Verweis auf eine Ausnahme, die in der aktuellen Kompilierungsumgebung verfügbar ist. Der Compiler prüft mithilfe von Regeln für die Namenssuche, ob die angegebene Ausnahme vorhanden ist, und übersetzt in der Ausgabe-XML member in den kanonischen Elementnamen. Der Compiler gibt eine Warnung aus, wenn er nicht gefunden memberwird.
Setzen Sie den Namen in einfache oder doppelte Anführungszeichen.
Weitere Informationen zum Erstellen eines cref Verweises auf einen generischen Typ finden Sie unter <see>.
description
Eine Beschreibung
Hinweise
Kompilieren sie, /doc um Dokumentationskommentare in einer Datei zu verarbeiten.
Der MSVC-Compiler versucht, Verweise in einem Durchgang durch die Dokumentationskommentare aufzulösen cref . Wenn Sie die C++-Nachschlageregeln verwenden, wird der Verweis als nicht aufgelöst markiert, wenn ein Symbol vom Compiler nicht gefunden wird. Weitere Informationen finden Sie unter <seealso>.
Beispiel
// 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^) {
}
}
};