Visual C++ 檔標籤的分隔符號
使用檔標籤需要 分隔符號 ,以向編譯器指出檔批註開始和結束的位置。
您可以搭配使用下列類型的分隔符號與 XML 文件標記︰
分隔符號 | 描述 |
---|---|
/// |
這是 Visual Studio C++ 專案範本所顯示之檔範例中所示的表單。 |
/** */ |
這些是多行分隔符號。 |
使用 /** */
分隔符號時,有一些格式化規則:
對於包含
/**
分隔符號的行,如果行的其餘部分是空白字元,則行不會處理批註。 如果第一個字元是空白字元,則會忽略該空白字元,並處理該行的其餘部分。 否則,會將/**
分隔符號後面的整行文字處理為註解的一部分。針對包含
*/
分隔符號的行,如果只有分隔符號的*/
空白字元,則會忽略該行。 否則,根據下列項目符號中所述的模式比對規則,會將到*/
分隔符號為止的整行文字都處理為註解的一部分。針對以分隔符號開頭
/**
的行之後的行,編譯器會在每一行開頭尋找由選擇性空白字元和星號組成的常見模式,*
後面接著更選擇性的空白字元。 如果編譯器在每行開頭找到一組通用字元,則會忽略/**
分隔符號後面所有行的模式,甚至可能到包含*/
分隔符號的行。
範例
下列註解中唯一會處理的部分是開頭為
<summary>
的那一行。 下列兩個標記格式會產生相同的註解:/** <summary>text</summary> */ /** <summary>text</summary> */
編譯器套用模式 " * " 以忽略第二行和第三行開頭。
/** * <summary> * text </summary>*/
編譯器在此批註中找不到模式,因為第二行沒有星號。 第二行和第三行的所有文字,直到
*/
之前,都會在批註中處理。/** * <summary> text </summary>*/
基於兩個原因,編譯器在此註解中找不到任何模式。 首先,星號前面沒有以一致數目空格開頭的行。 其次,第五行的開頭是 Tab,這與空白字元不符。 第二行的所有文字,直到
*/
將處理為批註的一部分為止。/** * <summary> * text * text2 * </summary> */
另請參閱
意見反應
https://aka.ms/ContentUserFeedback。
即將登場:在 2024 年,我們將逐步淘汰 GitHub 問題作為內容的意見反應機制,並將它取代為新的意見反應系統。 如需詳細資訊,請參閱:提交並檢視相關的意見反應