<example> (Visual C++)
Il tag <example> consente di specificare un esempio relativo all'utilizzo di un metodo o di un altro membro della libreria.In genere, tale operazione comporterebbe l'utilizzo del tag di <code>.
<example>description</example>
Parametri
- description
Descrizione dell'esempio di codice.
Note
Eseguire la compilazione con /doc per elaborare in un file i commenti per la creazione della documentazione.
Esempio
// 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;
}
};