<example> (Visual C++)
La balise <example> vous permet de spécifier un exemple d'utilisation d'une méthode ou de tout autre membre de bibliothèque.En général, cela comporterait également l'utilisation de la balise d' <code> .
<example>description</example>
Paramètres
- description
Description de l'exemple de code.
Notes
Compilez avec /doc pour traiter les commentaires de documentation et les placer dans un fichier.
Exemple
// 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;
}
};