Sandcastle文档xml代码示例，显示时不返回回车

Question

我正在使用sandcastle在web服务API上进行文档记录，并对顶级命名空间进行总结和注释，我已将sandcastle.xml文件添加到我的项目中。

我的问题是，当我尝试将xml示例代码添加到名称空间备注部分时在该xml文件中，sandcastle将xml代码全部呈现在一行中，没有任何回车。

<member name="N:BrokerServices.GatewayAsmx">
    <summary>summary text</summary>
    <remarks>
        remarks text
        <example>
               Sample xml code              
               <code lang="xml">
                <Membership>
                    <firstname>Cliff</firstname>
                    <lastname>Mayson</lastname>
                    <age>27</age>
                </Membership>
            </code>
        </example>
    </remarks>
</member>

结果呈现的代码示例显示为：

<Member><firstname>Cliff</firstname><lastname>Mayson</lastname><age>27</age></Member>

我尝试过使用\n或\r，但\n和\r字符留在了代码示例中：

<Member><firstname>Cliff</firstname>n
    <lastname>Mayson</lastname>n
    <age>27</age>r
</Member>

如何在代码中不显示换行符的情况下插入新行。

Answer 1

第一个选项：用<替换<字符
第二个选项：将XML代码放入<![CDATA[ ... ]]>块中
第三种选择：你也可以使用替代工具，如ForgeDoc：）

还有一件事：不要把示例块放在备注部分。Example是一个顶级标签。

Answer 2

当代码标记的语言属性是xml时，您需要将xml:space="preserve"属性添加到标记中，以便正确呈现xml示例。

例如。

<member name="N:BrokerServices.GatewayAsmx">
    <summary>summary text</summary>
    <remarks>
        remarks text 
    </remarks>
    <example>
        Sample xml code             
        <code lang="xml" xml:space="preserve">
            <Membership>
                <firstname>Cliff</firstname>
                <lastname>Mayson</lastname>
                <age>27</age>
            </Membership>
        </code>
    </example>
</member>

如果代码标记的lang属性值是c#或VB