<exception> balise de documentation

La balise <exception> vous permet de spécifier quelles exceptions peuvent être levées. Cette balise est appliquée à une définition de méthode.

Syntaxe

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

Paramètres

member
Référence à une exception disponible à partir de l’environnement de compilation actuel. À l’aide des règles de recherche de nom, le compilateur vérifie que l’exception donnée existe et traduit member en nom d’élément canonique dans le fichier XML de sortie. Le compilateur émet un avertissement s’il ne trouve memberpas .

Mettez le nom entre guillemets simples ou doubles.

Pour plus d’informations sur la création d’une cref référence à un type générique, consultez <see>.

description
Une description.

Notes

Compilez avec /doc pour traiter les commentaires de documentation dans un fichier.

Le compilateur MSVC tente de résoudre cref les références dans un seul passage par le biais des commentaires de documentation. Si vous utilisez les règles de recherche C++, lorsqu’un symbole n’est pas trouvé par le compilateur, la référence est marquée comme non résolue. Pour plus d’informations, consultez <seealso>.

Exemple

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

Voir aussi

Documentation XML