<exception> značka dokumentace

Značka <exception> umožňuje určit, které výjimky je možné vyvolat. Tato značka se použije u definice metody.

Syntaxe

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

Parametry

member
Odkaz na výjimku, která je k dispozici v aktuálním prostředí kompilace. Pomocí pravidel vyhledávání názvů kompilátor zkontroluje, že daná výjimka existuje, a přeloží member na název kanonického elementu ve výstupním XML. Kompilátor vydá upozornění, pokud ho nenajde member.

Uzavřete název do jednoduchých nebo dvojitých uvozovek.

Další informace o tom, jak vytvořit cref odkaz na obecný typ, naleznete v tématu <see>.

description
Popis.

Poznámky

Zkompilujte je /doc pro zpracování komentářů dokumentace k souboru.

Kompilátor MSVC se pokusí vyřešit cref odkazy v jednom průchodu komentáři dokumentace. Pokud používáte vyhledávací pravidla jazyka C++, pokud kompilátor nenajde symbol, označí se odkaz jako nevyřešený. Další informace najdete na webu <seealso>.

Příklad

// 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^) {
      }
   }
};

Viz také

Dokumentace XML