# 建議的文檔注釋標記（C# 編程指南） C# 編譯器處理代碼中的文檔注釋，將它們設置為 XML 文件格式，其文件名在 **/doc** 命令行選項中指定。若要創建基于編譯器生成的文件的最終文檔，您可以創建自定義工具，也可以使用諸如等工具 [約定](http://shfb.codeplex.com/)。 在代碼構造（如類型和類型成員）上處理標記。 |  注意 | | :-- | | 文檔注釋不能應用于命名空間。 | 編譯器將處理任何為有效 XML 的標記。下列標記提供了用戶文檔中常用的功能。 ## 標記 | [&lt;c&gt;](https://msdn.microsoft.com/zh-cn/library/te6h7cxs.aspx) | [&lt;para&gt;](https://msdn.microsoft.com/zh-cn/library/x640hcd2.aspx) | [&lt;see&gt;](https://msdn.microsoft.com/zh-cn/library/acd0tfbe.aspx)* | |:--- |:--- |:--- | | [&lt;code&gt;](https://msdn.microsoft.com/zh-cn/library/f8hahtxf.aspx) | [&lt;param&gt;](https://msdn.microsoft.com/zh-cn/library/8cw818w8.aspx)* | [&lt;seealso&gt;](https://msdn.microsoft.com/zh-cn/library/xhd7ehkk.aspx)* | | [&lt;example&gt;](https://msdn.microsoft.com/zh-cn/library/9w4cf933.aspx) | [&lt;paramref&gt;](https://msdn.microsoft.com/zh-cn/library/wb7x2fhw.aspx) | [&lt;summary&gt;](https://msdn.microsoft.com/zh-cn/library/2d6dt3kf.aspx) | | [&lt;exception&gt;](https://msdn.microsoft.com/zh-cn/library/w1htk11d.aspx)* | [&lt;permission&gt;](https://msdn.microsoft.com/zh-cn/library/h9df2kfb.aspx)* | [&lt;typeparam&gt;](https://msdn.microsoft.com/zh-cn/library/ms173191.aspx)* | | [&lt;include&gt;](https://msdn.microsoft.com/zh-cn/library/9h8dy30z.aspx)* | [&lt;remarks&gt;](https://msdn.microsoft.com/zh-cn/library/3zw4z1ys.aspx) | [&lt;typeparamref&gt;](https://msdn.microsoft.com/zh-cn/library/ms173192.aspx) | | [&lt;list&gt;](https://msdn.microsoft.com/zh-cn/library/y3ww3c7e.aspx) | [&lt;returns&gt;](https://msdn.microsoft.com/zh-cn/library/4dcfdeds.aspx) | [&lt;value&gt;](https://msdn.microsoft.com/zh-cn/library/azda5z79.aspx) | （* 表示編譯器驗證語法。） 如果想要尖括號出現在文檔注釋文本中，使用 &lt; 和 &gt;。如下面示例所示。 <a>XML</a> ``` /// <summary cref="C &lt; T &gt;"> /// </summary> ``` ## 請參閱 [C# 編程指南](https://msdn.microsoft.com/zh-cn/library/67ef8sbd.aspx) [/doc (C# Compiler Options)](https://msdn.microsoft.com/zh-cn/library/3260k4x7.aspx) [XML 文檔注釋（C# 編程指南）](https://msdn.microsoft.com/zh-cn/library/b2s063f7.aspx)