共用方式為


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

更新:2007 年 11 月

C# 編譯器會將您程式碼中的文件註解處理為一個 XML 檔案。處理 XML 檔案以建立文件的細節需要在您的站台實作。

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

注意事項:

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

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

標記

<c>

<para>

<see>*

<code>

<param>*

<seealso>*

<example>

<paramref>

<summary>

<exception>*

<permission>*

<typeparam>*

<include>*

<remarks>

<typeparamref>

<list>

<returns>

<value>

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

如果您希望角括弧出現在文件註解的內容中,請使用 < 和 >。例如,<角括弧中的文字>。

請參閱

工作

XML 文件範例

概念

C# 程式設計手冊

參考

/doc (處理文件註解) (C# 編譯器選項)

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