Используйте XML в документации .net

Я создаю документацию для проекта 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, но на данный момент я был бы счастлив просто заставить работать отступы.


vb.net documentation sandcastle
person Shahar Mosek    schedule 10.02.2014    source источник
comment
Вы уже пытались поместить свой Xml в узел <code></code>?   -  person Filburt    schedule 10.02.2014
comment
@ Филбурт Да. Но потом все сливается в одну строку. Если я использую ‹para›, чтобы попытаться разбить строки, они не анализируются, и я вижу текст ‹para› в своей документации.   -  person Shahar Mosek    schedule 10.02.2014
comment
Какой инструмент вы используете для компиляции документации? Добавьте соответствующий тег к вашему вопросу.   -  person Filburt    schedule 10.02.2014

Ответы (1)


arrow_upward
0
arrow_downward

Если вы используете Sandcastle, документация предлагает встроить ваш пример кода 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>

У меня еще не было возможности проверить это.

person Filburt    schedule 10.02.2014
comment
@Filbert Работает отлично! - person Shahar Mosek; 11.02.2014