<example> (Visual C++)

Mit dem <example>-Tag kann ein Beispiel für die Verwendung einer Methode oder eines anderen Bibliothekmembers angegeben werden.Häufig ist dies auch Verwendung des <code>-Tag einschließen.

<example>description</example>

Parameter

• description
  eine Beschreibung des Codebeispiels.

Hinweise

Dokumentationskommentare werden zu einer Datei verarbeitet, indem sie mit "/doc" kompiliert werden.

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

Weitere Ressourcen

XML Documentation (Visual C++)