<example> balise de documentation

La balise <example> vous permet de spécifier un exemple d’utilisation d’une méthode ou de tout autre membre de la bibliothèque. Généralement, l’utilisation de cette balise implique également la <code> balise.

Syntaxe

/// <example>description</example>

Paramètres

description
Description de l’exemple de code.

Notes

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

Exemple

// xml_example_tag.cpp
// compile with: /clr /doc /LD
// post-build command: xdcmake xml_example_tag.dll

/// Text for class MyClass.
public ref class MyClass {
public:
   /// <summary>
   /// GetZero method
   /// </summary>
   /// <example> This sample shows how to call the GetZero method.
   /// <code>
   /// int main()
   /// {
   ///    return GetZero();
   /// }
   /// </code>
   /// </example>
   static int GetZero() {
      return 0;
   }
};

Voir aussi

Documentation XML