<example> (C# 程式設計手冊)

更新：2007 年 11 月

<example>description</example>

參數

• description
  為程式碼範例的描述。

備註

<example> 標記讓您指定一個範例，說明如何使用方法或其他程式庫成員。這通常會包含使用 <code> 標記。

使用 /doc 進行編譯，將文件註解處理為檔案。

範例

// compile with: /doc:DocFileName.xml 

/// text for class TestClass
public class TestClass
{
    /// <summary>
    /// The GetZero method.
    /// </summary>
    /// <example> This sample shows how to call the GetZero method.
    /// <code>
    /// class TestClass 
    /// {
    ///     static int Main() 
    ///     {
    ///         return GetZero();
    ///     }
    /// }
    /// </code>
    /// </example>
    public static int GetZero()
    {
        return 0;
    }

    /// text for Main
    static void Main()
    {
    }
}

請參閱

概念

C# 程式設計手冊

參考

建議使用的文件註解標籤 (C# 程式設計手冊)