<exception> tag della documentazione

Il tag <exception> consente di specificare le eccezioni che possono essere generate. Questo tag viene applicato a una definizione di metodo.

Sintassi

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

Parametri

member
Riferimento a un'eccezione disponibile nell'ambiente di compilazione corrente. Quando si usano regole di ricerca del nome, il compilatore controlla che l'eccezione specificata esista e converte member nel nome canonico dell'elemento nel file XML di output. Il compilatore genera un avviso se non trova member.

Racchiudere il nome tra virgolette singole o doppie.

Per altre informazioni su come creare un cref riferimento a un tipo generico, vedere <see>.

description
Una descrizione.

Osservazioni:

Compilare con /doc per elaborare i commenti della documentazione in un file.

Il compilatore MSVC tenta di risolvere cref i riferimenti in un solo passaggio tra i commenti della documentazione. Se si usano le regole di ricerca C++, quando un simbolo non viene trovato dal compilatore, il riferimento viene contrassegnato come non risolto. Per ulteriori informazioni, vedere <seealso>.

Esempio

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

Vedi anche

Documentazione XML