有什么方法可以保留 C# XML 評論中的空白？

Question

我目前正在記錄我的 C# 代碼，並且會發現包含一個直接顯示如何調用一段代碼的代碼塊很有用。 我使用嵌入到摘要中的<code>標記：

雖然這通常有效，但我想保留空白（換行符、縮進）。 到目前為止，我嘗試了以下方法：

• 我將xml:space="preserve"屬性應用於<code>標記，但這根本沒有效果。
• 我使用<br />來表示單獨的新行（這適用於 VS 2019 ），但我不能插入空格或制表符。 我嘗試使用  （空間）和	 （對於選項卡），但彈出窗口不會顯示這些。
• 我嘗試使用CDATA部分，但中間的代碼根本沒有顯示。

有什么方法可以在 C# XML 注釋的代碼標簽中保留空格？ 提前謝謝你的幫助。

Answer 1

您的第一個 XML 文檔評論是正確的。 您不應依賴 Intellisense 在工具提示中顯示的內容。 Intellisense 並不尊重所有格式，但隨着 VS 的每個版本，它都會變得更好。

<code>標記中的換行符和空格受到從 XML 注釋生成文檔的工具的尊重，例如VSdocman （我是作者）或 Sandcastle。 這同樣適用於 CDATA。 因此，例如，如果您從您的注釋中生成 HTML 文檔，您的代碼塊看起來會很好，其中包含所有空格和換行符。

如果您想在 Intellisense 中也能正確看到它，則必須等待，甚至更好的是，將 Visual Studio 的反饋發送給 MS 團隊。