<example> značka dokumentace

Značka <example> umožňuje určit příklad použití metody nebo jiného člena knihovny. Použití této značky by také zahrnovalo <code> značku.

Syntaxe

/// <example>description</example>

Parametry

description
Popis ukázky kódu.

Poznámky

Zkompilujte je /doc pro zpracování komentářů dokumentace k souboru.

Příklad

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

Viz také

Dokumentace XML