NewLine в резюме об'єкта


98

Привітання

При встановленні зведення для властивості / поля / методу тощо .. чи можна мати в ньому новий рядок?

/// <summary>
/// This is line 1
/// This is line 2
/// </summary>
public bool TestLine { get; set; }

Коли я встановлюю це, воно відображається як при наведенні курсора миші:

bool TestLine
This is line 1 This is line 2

Але я хочу, щоб це відображалося як:

bool TestLine
This is line 1 
This is line 2

Я намагався використовувати, \nале це не працює. Чи є спосіб зробити це?

Відповіді:


186

Ви хочете використати щось подібне

/// <summary> 
/// Your Main comment 
/// <para>This is line 1</para> 
/// <para>This is line 2</para> 
/// </summary> 
public bool TestLine { get; set; }

1
@YetA AnotherUser, а як щодо порожнього рядка?
Бехзад

1
@Behzad спробуйте використовувати <para>&nbsp;</para>.
YetA AnotherUser

15
Я ненавиджу ці зайві рядки :(
Ян Мачачек,

10
У IDE Visual Studio 2017 вищевказане "рішення" насправді відображає самотній ЧИСТИЙ РЯдок між рядком 1 і рядком 2 (тобто новий рядок після рядка 1, за яким слідує порожній рядок, а потім рядок 2) - це не те саме новий рядок, як вимагав OP. Це помилка в IDE VS 2017 - чи всі, хто проголосував, не бачать, що ця відповідь не дає того, що OP показує як бажаний результат?
Язимов

Це новий абзац, а не новий рядок. Мені здається, що синтаксис документації дещо обмежує.
GrizzlyMcBear


12

Це може бути старий потік, але я шукав anwser під час використання Visual Studio 2019 . Я хотів розриви абзаців та рядків. Для мене добре працює наступне:

/// <summary>
/// <para>parameter name="guidType" options:</para>
/// <br>0 = SequentialAsString</br>
/// <br>1 = SequentialAsBinary</br>
/// <br>2 = SequentialAtEnd</br>
/// </summary>

Виробляє наступне:

parameter name="guidType" options:

0 = SequentialAsString
1 = SequentialAsBinary
2 = SequentialAtEnd

4
Для VS2019 і пізніше ця відповідь технічно правильніша за прийняту відповідь.
Ріан Уолтерс,

Ви також можете просто використовувати <br /> у кінці рядка у VS2019. Ці рішення дають фактичний розрив рядка, а не новий абзац із порожнім рядком! Дякую
Філіп

5

Ви можете використовувати, <para />щоб додати новий рядок у підсумку:

/// <summary> 
/// Main comment<para />
/// Line 1<para />
/// Line 2<para />
/// </summary>
public bool TestLine { get; set; }

Виглядає наче:

Main comment
Line 1
Line 2

З найкращими побажаннями!


2

Я просто додаю це для тих, хто використовує Xamarin Studio, як я. Я виявив, що жодне з наведених вище рішень не працює для мене, але це:

/// <summary>
/// Main summarry line.
/// <para></para>
/// <para></para>
/// Your secondary summary
/// </summary>

Це дає такий результат:

Summary  
Main summary line.

Your secondary summary

1

Якщо ви використовуєте Swashbuckle (бібліотека інтеграції веб-інтерфейсу Swagger), тоді його <para></para>слід замінити на, <p></p>а <br/>також можна використовувати.

так наступне

    /// <para>
    ///     Flag1, Flag2
    ///     - bool flags, optional.
    /// </para>

стає

    /// <p>
    ///     Flag1, Flag2<br/>
    ///     - bool flags, optional.
    /// </p>

Проблема вже описана тут: Як додати розрив рядка до документації Swashbuckle? - за допомогою спеціальної конфігурації, коментар domaindrivendev, https://github.com/domaindrivendev/Swashbuckle/issues/258 - про <br/>використання.


0

Ви можете законно додавати пара-теги, але насправді це створює новий абзац для кожного нового рядка, і міжрядковий інтервал здається вимкненим.
Я особисто додаю 1 абзац навколо абзацу, а потім brтеги в кінці рядків, на яких я хотів перерву, що зберігає гідний інтервал між рядками:

/// <summary> 
/// <para>Main comment<br /> 
/// Line 1<br />
/// Line 2</para> 
/// </summary>
public bool TestLine { get; set; }

3
Це не працює, і в пробілі з <para> немає нічого. Яку версію VS / .Net ви використовуєте?
Дані

2
Теги HTML ігноруватимуться summary, навіть якщо вони знаходяться всередині paraтегу.
Лазаро Фернандес Ліма Сулейман

-7

Я б запропонував використовувати це форматування, якщо вам потрібні кілька рядків у резюме, не ускладнюючи їх. Це спрацює, якщо ви використовуєте тег <br /> після кожного рядка. (використовуючи його в будь-якому місці тексту, вийде новий рядок, де також міститься тег.)

Хоча, зауважте, що якщо у вас є пробіл після тегу <br />, ви отримаєте додатковий пробіл на наступному рядку. Отже, ви хочете мати однакову кількість місця на кожному рядку, тож кожен рядок він буде знаходитися по прямій.

/// <summary>
/// This is line 1<br />
/// This is line 2<br />
/// This is line 3<br />
/// </summary>
public bool TestLine { get; set; }

3
Перш за все я спробував, перш ніж шукати рішення, оскільки це не працює!
Філіпп

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