Sandcastle文档xml代码示例显示不带回车符
我正在使用sandcastle在web服务API上编写文档,并对顶层名称空间进行总结和注释,我已将一个sandcastle.xml文件添加到我的项目中 我的问题是当我尝试向namespace备注部分添加xml示例代码时 在该xml文件中,sandcastle在一行上呈现所有xml代码,而不返回任何回车符Sandcastle文档xml代码示例显示不带回车符,xml,documentation,sandcastle,Xml,Documentation,Sandcastle,我正在使用sandcastle在web服务API上编写文档,并对顶层名称空间进行总结和注释,我已将一个sandcastle.xml文件添加到我的项目中 我的问题是当我尝试向namespace备注部分添加xml示例代码时 在该xml文件中,sandcastle在一行上呈现所有xml代码,而不返回任何回车符 <member name="N:BrokerServices.GatewayAsmx"> <summary>summary text</summary>
<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>
摘要文本
备注文本
示例xml代码
悬崖
曼森
27
生成的渲染代码示例显示为:
<Member><firstname>Cliff</firstname><lastname>Mayson</lastname><age>27</age></Member>
CliffMayson27
我已尝试使用\n或\r,但代码示例中\n和\r字符仍保留:
<Member><firstname>Cliff</firstname>\n
<lastname>Mayson</lastname>\n
<age>27</age>\r
</Member>
Cliff\n
梅森\n
27\r\n
如何插入没有代码中显示的新行字符的新行。1选项:替换
块。
第三个选项:您还可以使用其他工具,如:)
还有一件事:不要在备注部分添加示例块<代码>示例是顶级标记。当代码标记的语言属性是xml时,需要向标记添加xml:space=“preserve”属性,以便正确呈现xml示例
例如
摘要文本
备注文本
示例xml代码
悬崖
曼森
27
如果代码标记的lang属性值是c#或VBCheers,那么这是不必要的,您认为示例也是顶级标记似乎是正确的。虽然当它嵌套在备注中时似乎确实有效。
<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>