2014-02-10 3 views
1

Я создаю документацию для проекта VB.Net и пытаюсь показать образец XML-конфигурации.Использование XML в .net-документации

Лучшее, что я мог сделать до сих пор:

''' <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, но на данный момент, я бы доволен тем, что просто работает с отступом.

+0

Вы уже поставили свой Xml внутри узла ''? – Filburt

+0

@Filburt Да. Но потом все становится в одной строке. Если я использую , чтобы попытаться сломать строки, они не разобраны, и я вижу текст в своей документации. –

+0

Какой инструмент вы используете для компиляции вашей документации? Добавьте соответствующий тег к вашему вопросу. – Filburt

ответ

0

Если вы используете 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> 

Я не имел возможности проверить это пока.

+0

@ Филберт работает отлично! –