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

Question

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

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

Я хочу добавить" закодированный " разрыв строки в 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.

Я нахожу это раздражает...

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

455 4

c#.net xml-documentation

4 ответов:

Comments

Ничего не найдено.

pstrjds · Accepted Answer · 2018-07-04 09:50:22

добавить <para />. Это даст вам абзац.

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

пример (на основе оригинальный ОП образца):
/// <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>

IlPADlI · Accepted Answer · 2018-03-18 09:00:52

Это мое использование, как   , его работа :)
/// <summary>
/// Value: 0/1/2
/// <para/>0 foo,
/// <para/>1 bar,
/// <para/>2 other
/// </summary>

Joel · Accepted Answer · 2013-04-10 15:03:18

добавить a <para> тег со специальным символом в нем, 255 символов, или невидимый чар.
/// <summary>
/// Some text
/// <para>   </para>
/// More text
/// </summary>
/// <param name="str">Some string</param>
public void SomeMethod(string str) { }
это будет работать так:

Travis J · Accepted Answer · 2014-08-05 01:07:36

  и   кажется, не работает, и иногда это на самом деле не о том, чтобы сделать <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