使 XML 註釋換行
更新頁 :
頁面創建日期 :
您可以在 Visual Studio 中的 C# 和 VB.NET 屬性和方法中編寫 XML 文件註釋。 這樣,當您編寫屬性或方法的代碼或滑鼠懸停時,可以使用 Sandcastle 等工具查看屬性和方法的說明。
然而,我通常寫在一行左右,因為可讀性下降,如果寫得太多,在某些情況下,我想顯示它分為多行。
如果你在評論中通常換行,你會期望在顯示描述時換行,但當你真正嘗試時,你會看到以下感覺。
<summary>
これは
普通に
改行したもの
<summary>
public int Amount1 { get; set; }
顯示描述的結果
它不會在描述性文本中換行,而是在佈局中,就像有空格一樣。 在 XML 中,空格和換行符的處理方式不同,Visual Studio 中的普通換行符不被視為文本換行符。
因此,如果要換行說明,該怎麼辦?我們使用“para”標記。 “帕拉”代表“段落”。 用要換行的單位括起來,用para標記括起來,如下所示:
<summary>
<para>paraを</para>
<para>使って</para>
<para>改行したもの</para>
</summary>
public int Amount2 { get; set; }
說明顯示為換行符,如圖所示。 使用文件生成工具時,它仍顯示為換行符。