<example> Dokumentationstag

Mit dem <example>-Tag kann ein Beispiel für die Verwendung einer Methode oder eines anderen Bibliothekmembers angegeben werden. Häufig würde die Verwendung dieses Tags auch das <code> Tag umfassen.

Syntax

/// <example>description</example>

Parameter

description
Eine Beschreibung des Codebeispiels.

Hinweise

Kompilieren sie, /doc um Dokumentationskommentare in einer Datei zu verarbeiten.

Beispiel

// 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;
   }
};

Siehe auch

XML-Dokumentation