有什么方法可以保留 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 团队发送反馈。