Как добавить разрыв строки в документации C # .NET

Question

Это должно быть проще ...

Я хочу добавить «кодированный» разрыв строки в документацию XML в моем коде

/// <summary>
/// Get a human-readable variant of the SQL WHERE statement of the search element. &lt;br/&gt;
/// Rather than return SQL, this method returns a string with icon-tokens, which 
/// could be used to represent the search in a condensed pictogram format.
/// </summary>

Как видите, я нашел несколько ответов, которые демонстрировали добавление скобок <и>. Интересно, что хороший разрыв строки 'ol
не создает разрыв строки во всплывающем окне Intellisense.

Я нахожу это раздражающим ...

Есть предложения?

Answer 1

Вы можете использовать тег <para /> для создания разрыва абзаца или вы можете заключить текст в теги <para></para> как способ группировки текста и добавления пустой строки после него, но нет эквивалента <br />или что-нибудь в этом роде.(Что в соответствии с этим старым сообщением на форуме MS разработано.) Вы можете получить список доступных тегов в этой статье документации от MS. Документирование вашего кода

Пример (на основе оригинального образца OP):

/// <summary>
/// <para>Get a human-readable variant of the SQL WHERE statement of the search element.</para>
/// Rather than return SQL, this method returns a string with icon-tokens, which 
/// could be used to represent the search in a condensed pictogram format.
/// </summary>

Answer 2

Это мое использование, как <br/>, оно работает:)

/// <summary>
/// Value: 0/1/2
/// <para/>0 foo,
/// <para/>1 bar,
/// <para/>2 other
/// </summary>

Answer 3

Добавьте тег <para> со специальным символом, 255 символом или невидимый символ .

/// <summary>
/// Some text
/// <para>   </para>
/// More text
/// </summary>
/// <param name="str">Some string</param>
public void SomeMethod(string str) { }

Будет работать так:

Answer 4

<br></br> и <br />, похоже, не работают, и иногда дело не в том, чтобы разделить предложения <para> так сильно, как желание иметь пустую строку для разделения проблем.Я упоминаю об этом здесь, потому что этот вопрос, кажется, является родителем для многих закрытых вопросов такого рода.

Единственное, что я нашел для работы, было

<para>&#160;</para>

Например,

/// <summary>
///     <para>
///         "This sentence shows up when the type is hovered"
///     </para>
///     <para>&#160;</para>
///     <para>int PrimaryKey</para>
///     <para>&#160;</para>
///     <para>virtual Relation Relation</para>
/// </summary>

Результаты в

"This sentence shows up when the type is hovered"

int PrimaryKey

virtual Relation Relation