# XML 文檔注釋（C# 編程指南） 在 Visual C# 中，你可以通過以下方式為代碼創建文檔：將特殊注釋字段中的 XML 元素包含在源代碼中注釋引用的代碼塊的前面，例如： ``` /// <summary> /// This class performs an important function. /// </summary> public class MyClass{} ``` 使用 [/doc](https://msdn.microsoft.com/zh-cn/library/3260k4x7.aspx) 選項進行編譯時，編譯器將在源代碼中搜索所有 XML 標記，并創建一個 XML 文檔文件。若要基于編譯器生成的文件創建最終文檔，你可以創建一個自定義工具，也可以使用 [Sandcastle](http://go.microsoft.com/fwlink/?LinkId=124061) 等工具。 若要引用 XML 元素（例如，你的函數將處理你要在 XML 文檔注釋中描述的特定 XML 元素），你可使用標準引用機制（&lt; 和 &gt;）。若要引用代碼引用 (**cref**) 元素中的通用標識符，則可使用轉義字符（例如，cref=”List&lt;T&gt;”）或大括號 (cref=”List{T}”)。作為特例，編譯器會將大括號解析為尖括號以在引用通用標識符時使作者能夠更輕松地進行文檔注釋。 |  注意 | | :-- | | XML 文檔注釋不是元數據；它們不包括在編譯的程序集中，因此無法通過反射對其進行訪問。 | ## 本節內容 * [建議的文檔注釋標記](https://msdn.microsoft.com/zh-cn/library/5ast78ax.aspx) * [處理 XML 文件](https://msdn.microsoft.com/zh-cn/library/fsbx0t7x.aspx) * [文檔標記分隔符](https://msdn.microsoft.com/zh-cn/library/5fz4y783.aspx) * [如何：使用 XML 文檔功能](https://msdn.microsoft.com/zh-cn/library/z04awywx.aspx) ## 相關章節 有關詳細信息，請參閱： * [/doc（處理文檔注釋）](https://msdn.microsoft.com/zh-cn/library/3260k4x7.aspx) ## C# 語言規范 有關詳細信息，請參閱 [C# 語言規范](https://msdn.microsoft.com/zh-cn/library/ms228593.aspx)。該語言規范是 C# 語法和用法的權威資料。 ## 請參閱 [C# 編程指南](https://msdn.microsoft.com/zh-cn/library/67ef8sbd.aspx)