Как добавить разрыв строки в документации С#.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>

Как вы можете видеть, я нашел несколько ответов, которые демонстрировали добавление < и > скобки. Интересно отметить, br/" > line break не создает разрыв строки во всплывающем окне Intellisense.

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

Любые предложения?

Ответы

Ответ 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>

Ответ 2

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

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

Ответ 3

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

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

Он будет работать следующим образом:

enter image description here

Ответ 4

Начиная с 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>

Вы можете увидеть приведенный выше пример в действии на следующем рисунке.

enter image description here

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

Ответ 5

<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