---
description: "Learn more about: XML documentation tag <example>"
title: "<example>  (C++ documentation comments)"
ms.date: 12/03/2021
f1_keywords: ["<example>"]
helpviewer_keywords: ["<example> C++ XML tag", "example C++ XML tag"]
ms.assetid: c821aaa7-7ea7-4bee-9922-6705ad57f877
---
# `<example>` documentation tag

The `<example>` tag lets you specify an example of how to use a method or other library member. Commonly, use of this tag would also involve the [`<code>`](code-visual-cpp.md) tag.

## Syntax

```cpp
/// <example>description</example>
```

### Parameters

*`description`*\
A description of the code sample.

## Remarks

Compile with [`/doc`](doc-process-documentation-comments-c-cpp.md) to process documentation comments to a file.

## Example

```cpp
// 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;
   }
};
```

## See also

[XML documentation](xml-documentation-visual-cpp.md)