在.net文档中使用XML

Question

我正在为VB.Net项目生成文档，并尝试显示示例XML配置。

我能做的最好的事情是：

''' <summary>
''' Description
''' </summary>
''' <remarks>
''' <para>&lt;element&gt;</para>
''' <para>  &lt;child&gt;value&lt;/child&gt;</para>
''' <para>&lt;/element&gt;</para>
''' </remarks>

这显示为：

<element>
<child>value</child>
</element>

我希望它显示为格式化的XML，但在这一点上，我会很高兴让缩进工作。

Answer 1

如果您使用Sandcastle，the documentations建议将您的Xml代码示例嵌入到<![CDATA[]]>中，如下所示：

''' <summary>
''' ...
''' </summary>
''' <example>
''' <code language="xml" title="Xml Code sample">
''' <![CDATA[
''' <?xml version="1.0" encoding="utf-8"?>
''' <element>
'''   <child>value</child>
''' </element>
''' ]]>
''' </code>
''' </example>

我还没机会测试这个。