使用.NET代码文档XML时在代码示例中包括HTML标记

pod7payv 于 2023-05-30 发布在 .NET

关注(0)|答案(1)|浏览(98)

.NET有一个特定的XML语法来记录代码。
<c></c>和<code></code>标记允许在注解中添加代码片段，但显然，当这些代码片段由HTML组成时，它们不能很好地工作，这是一个问题，因为我想记录我的函数的HTML标记输出。
例如，如果我编写以下（VB）文档注解：

''' <summary>
''' <code>
''' <div class="foo">Hello world</div>
''' </code>
''' </summary>

当我用指针悬停函数名时，它确实显示“Hello world”字符串，但不显示HTML标记。它似乎在解释它。
有没有一种方法可以在这些注解中显示HTML标记？
需要说明的是，我并不想在文档中添加样式，我真的希望它显示HTML标记本身。

1条答案

使用CDATA：

''' <summary>
''' <code><![CDATA[
''' <div class="foo">Hello world</div>
''' ]]></code>
''' </summary>

例如，我的产品VSdocman有一个注解编辑器，它可以自动将CDATA放入<code>块中。