有什么办法可以在 C# XML 注释中保留白色 space 吗?
Is there any way to preserve white space in C# XML comments?
我目前正在记录我的 C# 代码,并发现包含一个直接显示应如何调用一段代码的代码块很有用。我使用嵌入到摘要中的 <code>
标签:
虽然这通常有效,但我想保留白色 space(换行符、缩进)。到目前为止,我尝试了以下方法:
- 我将
xml:space="preserve"
属性应用于 <code>
标签,但这根本没有效果。
- 我使用
<br />
来表示单独的新行 (this works as of VS 2019),但我无法插入 space 或制表符。我尝试使用  
(对于 space)和 	
(对于选项卡),但弹出窗口不会显示这些。
- 我尝试使用
CDATA
部分,但中间的代码根本没有显示。
有没有办法在C#XML注释的代码标签中保留白色space?提前感谢您的帮助。
您的第一个 XML 文档评论是正确的。您不应依赖 Intellisense 在工具提示中显示的内容。 Intellisense 不尊重所有格式,但随着 VS 的每个版本都变得更好。
<code>
标签中的换行符和空格受到从 XML 注释生成文档的工具的尊重,例如 VSdocman(我是作者)或 Sandcastle。这同样适用于 CDATA。因此,例如,如果您从评论中生成一个 HTML 文档,您的代码块将看起来很好,包含所有空格和换行符。
如果你想在 Intellisense 中也能正确看到它,你必须等待,或者更好的是,将 Visual Studio 的反馈发送给 MS 团队。
我目前正在记录我的 C# 代码,并发现包含一个直接显示应如何调用一段代码的代码块很有用。我使用嵌入到摘要中的 <code>
标签:
虽然这通常有效,但我想保留白色 space(换行符、缩进)。到目前为止,我尝试了以下方法:
- 我将
xml:space="preserve"
属性应用于<code>
标签,但这根本没有效果。 - 我使用
<br />
来表示单独的新行 (this works as of VS 2019),但我无法插入 space 或制表符。我尝试使用 
(对于 space)和	
(对于选项卡),但弹出窗口不会显示这些。 - 我尝试使用
CDATA
部分,但中间的代码根本没有显示。
有没有办法在C#XML注释的代码标签中保留白色space?提前感谢您的帮助。
您的第一个 XML 文档评论是正确的。您不应依赖 Intellisense 在工具提示中显示的内容。 Intellisense 不尊重所有格式,但随着 VS 的每个版本都变得更好。
<code>
标签中的换行符和空格受到从 XML 注释生成文档的工具的尊重,例如 VSdocman(我是作者)或 Sandcastle。这同样适用于 CDATA。因此,例如,如果您从评论中生成一个 HTML 文档,您的代码块将看起来很好,包含所有空格和换行符。
如果你想在 Intellisense 中也能正确看到它,你必须等待,或者更好的是,将 Visual Studio 的反馈发送给 MS 团队。