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