Marca de documentação <example>

A marca <example> permite especificar um exemplo de como usar um método ou outro membro da biblioteca. Normalmente, o uso dessa marca envolve também o uso da marca <code>.

Sintaxe

/// <example>description</example>

Parâmetros

description
Uma descrição do exemplo de código.

Comentários

Compile com /doc para processar comentários de documentação em um arquivo.

Exemplo

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

Confira também

Documentação XML