<example> 标记表示“示例”区域。Section 标记。用于书写能辅助使用者理解并快速上手的示例代码等内容。

<example>description</example>

其中:

description

示例及其说明。

应用于

所有的类型及成员。

备注

此标记经常和 <code> 标记联用。

示例

[C#]
public class MyClass 
{
   /// <summary>
   /// The GetZero method.
   /// </summary>
   /// <example> This sample shows how to call the GetZero method.
   /// <code>
   ///   class MyClass 
   ///   {
   ///      public static int Main() 
   ///      {
   ///         return GetZero();
   ///      }
   ///   }
   /// </code>
   /// </example>
   public static int GetZero() 
   {
      return 0;
   }
}

请参见

标记用法 | NDoc 支持的标记 | <code> | Microsoft 的定义