天天看點

(C# 程式設計指南)

C# 程式員參考 

<summary>(C# 程式設計指南) 

<summary>description</summary>

參數

description

對象的摘要。

備注

<summary> 标記應當用于描述類型或類型成員。使用 <remarks> 添加針對某個類型說明的補充資訊。

<summary> 标記的文本是唯一有關 IntelliSense 中的類型的資訊源,它也顯示在對象浏覽器中。

使用 /doc 進行編譯可以将文檔注釋處理到檔案中。

示例

C#  複制代碼

// 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()

    {

    }

}