<example> (Visual C++)
La etiqueta <example> permite especificar un ejemplo de cómo utilizar un método u otro miembro de una biblioteca. Normalmente, esto también implican el uso de la etiqueta de <code> .
<example>description</example>
Parámetros
- description
Descripción del ejemplo de código.
Comentarios
Compile con el parámetro /doc para procesar los comentarios de documentación y generar un archivo con ellos.
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;
}
};