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

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

Я хочу добавить «кодированный» разрыв строки в документацию 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>

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

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

Какие-либо предложения?

Вы можете использовать <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>

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

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

Начиная с Visual Studio 2019, используйте <br/>для новых строк в комментариях.

Пример:

/// <summary>
/// This is a comment.<br/>
/// This is another comment <br/>
/// This is a long comment so i want it to continue <br/> on another line.
/// </summary>

Обратите внимание, что при использовании <br/>вместо <para>. Дополнительная строка не добавляется .

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

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

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

<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