<example> tag dokumentacji

Tag <example> umożliwia określenie przykładu użycia metody lub innego elementu członkowskiego biblioteki. Często użycie tego tagu wymaga również tagu <code> .

Składnia

/// <example>description</example>

Parametry

description
Opis przykładowego kodu.

Uwagi

Skompiluj element , /doc aby przetworzyć komentarze dokumentacji do pliku.

Przykład

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

Zobacz też

Dokumentacja XML