Etiqueta de documentación <example>

La etiqueta <example> le permite especificar un ejemplo de cómo usar un método u otro miembro de biblioteca. Normalmente, el uso de esta etiqueta también implica a la etiqueta <code>.

Sintaxis

/// <example>description</example>

Parámetros

description
Una descripción del ejemplo de código.

Comentarios

Compile con /doc para procesar los comentarios de documentación a un archivo.

Ejemplo

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

Consulte también

Documentación de XML