Як додати розрив рядка в документації на C # .NET


197

Це повинно бути легше ...

Я хочу додати "закодований" розрив рядка до документації 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 <br /> розрив рядків не створює розрив рядків у спливаючому вікні Intellisense.

Мені це дратує ...

Будь-які пропозиції?


3
Використовувати <br/> можна для створення розривів ліній, як у Visual studio 2019. Відповідь див . Тут .
23бл.

Відповіді:


317

Ви можете використовувати <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>

5
Ага! Тепер готували! Дякую! Це вже давно мене турбує ... Я побачив перелічений пара-параметр, але припустив, що це ярлик "параметра".
Tinkerer_CardTracker

2
Не працювали для мене. Використовуючи VB.NET на VS 2010, спробувавшись із кольоровим параметром Powertools та кольоровим параметром Powertools, <para>теги ігноруються, і все змішується в один рядок в Intellisense. Знайшов це питання, де Ганс пояснив проблему: stackoverflow.com/questions/7070737/… .
Неоліск

1
Переконайтеся, що ви додали тег </para> також =)
link64

87
Погано в цьому те, що він фактично додає один цілий порожній рядок, а не просто новий рядок.
Девід

6
Так хтось знайшов спосіб насправді вставити один рядок замість двох?

75

Це моє використання, начебто <br/>, працює :)

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

8
Чому ця відповідь спростована? Це працює і, здається, є набагато кращим рішенням, ніж використання <para>&#160;</para>, <para>&nbsp;</para>або невидимий персонаж ...
Діней

Це працює для нових рядків, але не буде вставляти порожній рядок між речами, як інші параметри.
Юшатак

16
В останніх версіях VS, <para/>здається, додається порожній рядок, а не просто розрив рядка.
Діней

2
@IlPADlI, +1 для прикладу використання. Підтверджено роботу над VS 2012 Ultimate Update 5.
Dennis T - Відновлення Моніки

9
VS 2017: додано порожній рядок, а не просто розрив рядків ... microsoft впевнений, що любить говорити нам, що ми хочемо зробити ...
Assimilater

41

Станом на 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>.


4
Ще корисно, оскільки це запитання є головним результатом google щодо того, як додати розрив рядка в документації на C #.
Dan

27

Додайте <para>тег із спеціальним char у ньому, 255 char чи невидимим char .

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

Він працюватиме так:

введіть тут опис зображення


8
Це корисно, проте &nbsp;не працює, натомість використовуйте/// <para>&#160;</para>
Роберт Х

1
Я особисто зберігаю /// <para> </para>в липкій записці. Тоді це просто скопіювати та вставити! (І це працює - принаймні для мене)
Джоел

2
Я не знаю чому, але папка для копіювання /// <para> </para>взагалі не працює. /// <para>&#160;</para>працює!
wenqiang

8
Замість того, щоб використовувати <para>тег між блоками тексту, слід використовувати <para>тег навколо всіх абзаців, крім першого в <summary>елементі. Для <typeparam>, <param>, <value>, <exception>і <returns>елементів, використовувати їх по всьому пунктам , якщо у вас є більше одного ( по бажанню , якщо у вас є тільки один для цих елементів). Для всіх інших елементів блоку (включаючи <note>всередині іншого елемента блоку) використовуйте <para>теги навколо всіх абзаців, навіть якщо у вас є лише один.
Сем Харвелл

1
Джерело: Я є автором цього, включаючи більшість стилів презентації: openstacknetsdk.org/docs-master/html/…
Сем Харвелл

3

<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
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.