# 文檔標記的分隔符（C# 編程指南） 使用 XML doc 注釋需要分隔符，分隔符為編譯器指示文檔注釋的起止位置。XML 文檔標記可以與以下幾種分隔符一起使用： /// 單行分隔符。這是顯示在文檔示例中并由 Visual C# 項目模板使用的形式。如果有后接分隔符的空白字符，則此字符將不包括在 XML 輸出中。 |  注意 | | :-- | | Visual Studio IDE 具有一項稱為“智能注釋編輯”的功能，它自動插入 <summary> 和 </summary> 標記，并且當您在代碼編輯器中鍵入 /// 分隔符后將光標移動到這些標記內。從項目屬性頁的 [選項、文本編輯器、C#、格式設置](https://msdn.microsoft.com/zh-cn/library/03864tbz.aspx) 可以訪問此功能。 | /** */ 多行分隔符。 以下是使用 /** */ 分隔符時要遵循的一些格式設置規則： * 對于包含 /** 分隔符的行，如果該行的其余部分為空白，則不將該行處理為注釋。如果 /** 分隔符后面的第一個字符為空白，則忽略此空白字符并處理該行的剩余部分。否則，將 /** 分隔符后的整行文本處理為注釋的一部分。 * 對于包含 */ 分隔符的行，如果到 */ 分隔符為止僅有空白，則忽略該行。否則，將到 */ 分隔符為止的那行文本處理為注釋的一部分，同時必須遵循以下描述的模式匹配規則。 * 對于以 /** 分隔符開頭的行后面的那些行，編譯器會在每個行的開頭尋找一個常用模式。該模式可以包含可選的空白和一個星號 (*)，后跟多個可選的空白。如果編譯器在每行的開頭找到不以 /** 分隔符或 */ 分隔符開頭的常見模式，則它將忽略每行的該模式。 下面的示例闡釋了這些規則。 * 以下注釋中將被處理的唯一部分是以 <summary> 開頭的行。這三個標記格式產生相同的注釋。 ``` /** <summary>text</summary> */ /** <summary>text</summary> */ /** * <summary>text</summary> */ ``` * 編譯器在第二行和第三行的開頭標識“*”的常見模式。該模式不包括在輸出中。 ``` /** * <summary> * text </summary>*/ ``` * 編譯器在以下注釋中找不到任何常見模式，因為第三行的第二個字符沒有星號。因此，第二行和第三行中的所有文本都將被處理為注釋的一部分。 ``` /** * <summary> text </summary> */ ``` * 編譯器之所以在此注釋中沒找到任何模式有以下兩個原因。首先，星號前的空格數并不一致。其次，第五行是以 Tab 開頭的，它并不等效于空格。因此，從第二行到第五行的所有文本都將被處理為注釋的一部分。 ``` /** * <summary> * text * text2 * </summary> */ ``` ## 請參閱 [C# 編程指南](https://msdn.microsoft.com/zh-cn/library/67ef8sbd.aspx) [XML 文檔注釋（C# 編程指南）](https://msdn.microsoft.com/zh-cn/library/b2s063f7.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)