使用C# XML 文檔注釋生成API幫助文檔

      C# XML 文檔注釋

<summary>description</summary>
      描述類型或類型成員。
      description：對象的摘要。

<remarks>description</remarks>
      添加有關某個類型的信息，從而補充由 <summary> 所指定的信息。
      description：成員的說明。

<example>description</example>
      使用方法或其他庫成員的示例。這通常涉及使用 <code> 標記。
      description：代碼示例的說明。

<seealso cref="member"/>
      指定希望在“請參見”一節中出現的文本。
      member：對可以通過當前編譯環境進行調用的成員或字段的引用。必須將 member 括在雙引號 (" ") 中。

<typeparam name="name">description</typeparam>
      描述泛型類型或方法的單個類型參數。
      name：類型參數的名稱。將此名稱用雙引號括起來 (" ")。
      description：類型參數的說明。

<param name="name">description</param>
     描述方法的單個參數。
     name：方法參數名。將此名稱用雙引號括起來 (" ")。
     description：參數說明。

<returns>description</returns>
     描述方法的返回值。
     description：返回值的說明。

<value>property-description</value>
     描述屬性所代表的值。
     property-description：屬性的說明。
 
<permission cref="member">description</permission>
    成員的訪問權限。使用 PermissionSet 類可以指定對成員的訪問。
    member：對可從當前編譯環境中獲取的權限的引用。必須將 member 括在雙引號 (" ") 中。
    description：對成員的訪問的說明。

<exception cref="member">description</exception>
     指定哪些異常可能被引發。此標記可用在方法、屬性、事件和索引器的定義中。
     member：對可從當前編譯環境中獲取的異常的引用。必須將 member 括在雙引號 (" ") 中。
     description：異常的說明。
 
<c>text</c>
     將說明中的文本標記為代碼。
     text：希望將其指示為代碼的文本。

<code>content</code>
     將多行文本指示為代碼。
     content：希望將其指示為代碼的文本。
 
<see cref="member"/>
     從文本內指定鏈接。
     member：對可以通過當前編譯環境進行調用的成員或字段的引用。應將 member 放在雙引號 (" ") 中。
 
<paramref name="name"/>、<typeparamref name="name"/>
     分別引用某個參數或某個類型參數。
     member：要引用的參數名（類型參數的名稱）。將此名稱用雙引號括起來 (" ")。

<para>content</para>
      用于諸如 <summary>、<remarks> 或 <returns> 等標記內，使您得以將段落添加到文本中。
      content：段落文本。

<list type="bullet" | "number" | "table">
    <listheader>
        <term>term</term>
        <description>description</description>
    </listheader>
    <item>
        <term>term</term>
        <description>description</description>
    </item>
</list>

      <listheader> 塊用于定義表或定義列表中的標題行。定義表時，只需為標題中的項提供一個項。
      列表中的每一項都用一個 <item> 塊來描述。創建定義列表時，既需要指定 term 也需要指定 description。但是，對于表、項目符號列表或編號列表，只需為 description 提供一個項。
      列表或表所擁有的 <item> 塊數可以根據需要而定。
      term：要定義的項，該項將在 description 中定義。
      description：項目符號列表或編號列表中的項或者 term 的定義。

       除了使用微軟Sandcastle的文檔生成工具，還可以使用DocsBuilder根據程序集和XML注釋文檔生成幫助文件。

       DocsBuilder還可以通過自定義模板文件，生成任何想要的文檔內容。

       下載地址：http://原網站已經失效/DocsBuilder/DocsBuilderGUI.zip

       DocsBuilder主頁：http://原網站已經失效/DocsBuilder.xhtml