Как добавить разрыв строки C#.NET документация
Это должно быть waaaay проще...
Я хочу добавить" закодированный " разрыв строки в XML-документацию в моем коде
/// <summary>
/// Get a human-readable variant of the SQL WHERE statement of the search element. <br/>
/// 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.
Я нахожу это раздражает...
какие предложения?
4 ответов
добавить <para />
. Это даст вам абзац.
редактировать
Вы можете обернуть текст в <para></para>
теги как способ сгруппировать текст и добавить пустую строку после него, но нет эквивалента <br />
или что-то в этом роде. (Который, согласно этой старый пост форума 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>
Это мое использование, как <br/>
, его работа :)
/// <summary>
/// Value: 0/1/2
/// <para/>0 foo,
/// <para/>1 bar,
/// <para/>2 other
/// </summary>
добавить <para>
тег со специальным символом в нем, 255 char, или невидимый чар.
/// <summary>
/// Some text
/// <para> </para>
/// More text
/// </summary>
/// <param name="str">Some string</param>
public void SomeMethod(string str) { }
это будет работать так:
<br></br>
и <br />
кажется, не работает, и иногда это на самом деле не о том, чтобы сделать <para>
предложения разделяются так же, как желание иметь пустую строку для разделения беспокойства. Я упоминаю об этом здесь, потому что этот вопрос, по-видимому, является родителем многих закрытых вопросов такого рода.
единственное, что я нашел, чтобы работать было
<para> </para>
/// <summary>
/// <para>
/// "This sentence shows up when the type is hovered"
/// </para>
/// <para> </para>
/// <para>int PrimaryKey</para>
/// <para> </para>
/// <para>virtual Relation Relation</para>
/// </summary>
результаты
"This sentence shows up when the type is hovered"
int PrimaryKey
virtual Relation Relation