<example> (Visual C++)
Тег <example> позволяет указывать пример того, как использовать метод или другой элемент библиотеки.Как правило, это также включена с помощью тега <code>.
<example>description</example>
Параметры
- description
Описание примера кода.
Заметки
Чтобы обработать и сохранить комментарии документации в файл, при компиляции необходимо использовать параметр /doc.
Пример
// 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;
}
};