NewLine в сводке объекта

Question 1

Приветствую

При настройке сводки для свойства / поля / метода и т. Д. Можно ли добавить в него новую строку?

/// <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но это не сработало. Есть ли способ сделать это?

Question 2

Вы хотите использовать что-то вроде этого

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

Question 3

Да:

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

Question 4

Это может быть старый поток, но я искал 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

Question 5

Вы можете использовать <para />для добавления новой строки в сводку:

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

Выглядит как:

Main comment
Line 1
Line 2

С уважением!

Question 6

Я просто добавляю это для всех, кто использует Xamarin Studio, как и я. Я обнаружил, что ни одно из вышеперечисленных решений не работает для меня, но это помогло:

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

Это дает следующий результат:

Summary  
Main summary line.

Your secondary summary

Question 7

Если вы используете Swashbuckle (библиотеку интеграции Swagger Web API), то <para></para>ее следует заменить на, а  также можно использовать.

так что следующие

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

становится

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

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

Question 8

Вы можете законно добавить теги para, но это фактически создает новый абзац для каждой новой строки, а межстрочный интервал исчезает.
Я лично добавляю 1 абзац вокруг абзаца, а затем brтеги в конце строк, которые я хотел бы разбить, что сохраняет приличный межстрочный интервал:

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

Question 9

Я бы предложил использовать это форматирование, если вы хотите, чтобы в сводке было несколько строк, не усложняя его. Это будет работать, если вы будете использовать тег после каждой строки. (использование его в любом месте текста приведет к созданию новой строки, где также находится тег.)

Однако обратите внимание, что если у вас есть пробел после тега , вы получите дополнительный пробел в следующей строке. Итак, вы хотите, чтобы в каждой строке было одинаковое количество места, чтобы каждая строка была на прямой.

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