<example> (Visual C++)
A marca de <example> permite que você especifique um exemplo de como usar um método ou outro membro da biblioteca.Geralmente, isso também envolveria o uso da marca de <code> .
<example>description</example>
Parâmetros
- description
Uma descrição do código de exemplo.
Comentários
Compile com /doc para processar comentários de documentação para 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;
}
};