<example> тег документации
Тег <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;
}
};