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

<summary>description</summary>

參數

• description
  為物件的摘要。

備註

<summary> 標記應用於描述型別或型別成員。 使用 <remarks> 為型別描述加入補充資訊。 使用 cref 屬性 (Attribute) 可以啟用如 Sandcastle 的文件工具，以建立程式碼項目說明頁面的內部超連結。

<summary> 標記的內容會是 IntelliSense 中有關型別資訊的唯一來源，也會在物件瀏覽器中顯示。

使用 /doc 進行編譯，將文件註解處理為檔案。 若要依據編譯器產生的檔案建立最後的文件，您可以建立自訂工具，或者是使用 Sandcastle 這類的工具。

範例

// compile with: /doc:DocFileName.xml 

/// text for class TestClass
public class TestClass
{
    /// <summary>DoWork is a method in the TestClass class.
    /// <para>Here's how you could make a second paragraph in a description. <see cref="System.Console.WriteLine(System.String)"/> for information about output statements.</para>
    /// <seealso cref="TestClass.Main"/>
    /// </summary>
    public static void DoWork(int Int1)
    {
    }

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

下列程式碼範例示範如何建立泛型型別的 cref 參考。

// compile with: /doc:DocFileName.xml 

// the following cref shows how to specify the reference, such that,
// the compiler will resolve the reference
/// <summary cref="C{T}">
/// </summary>
class A { }

// the following cref shows another way to specify the reference, 
// such that, the compiler will resolve the reference
// <summary cref="C &lt; T &gt;">

// the following cref shows how to hard-code the reference
/// <summary cref="T:C`1">
/// </summary>
class B { }

/// <summary cref="A">
/// </summary>
/// <typeparam name="T"></typeparam>
class C<T> { }

請參閱

參考

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

概念

C# 程式設計手冊