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

  • 發行項

C# 編譯器會處理程式碼中的文件註解，並且以 XML 的格式將這些註解儲存在檔案中，而該檔案的名稱會可以在 /doc 命令列選項中指定。 若要依據編譯器產生的檔案建立最後的文件，您可以建立自訂工具，或者是使用 Sandcastle 這類的工具。

標記在程式碼建構 (例如：型別與型別成員) 上處理。

注意事項注意事項

命名空間不能使用文件註解。

編譯器會處理任何合法的 XML 標記。 下列是在使用者文件中提供常用功能的標記。

標記

<c>

<para>

<see>*

<code>

<param>*

<seealso>*

<example>

<paramref>

<summary>

<exception>*

<permission>*

<typeparam>*

<include>*

<remarks>

<typeparamref>

<list>

<returns>

<value>

(* 表示編譯器會驗證語法)。

如果您要在文件註解的文字中顯示角括弧，請使用 &lt; 和 &gt;，如下列範例所示。

/// <summary cref="C &lt; T &gt;">

請參閱

參考

/doc (C# 編譯器選項)

XML 文件註解 (C# 程式設計手冊)

概念

C# 程式設計手冊