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

Привет

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

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

Ответ 1

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

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

Ответ 2

Да:

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

Ответ 3

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

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

Похоже:

Main comment
Line 1
Line 2

С наилучшими пожеланиями!

Ответ 4

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

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

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

Summary  
Main summary line.

Your secondary summary

Ответ 5

Если вы используете 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 - об использовании  .

Ответ 6

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

Ответ 7

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

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

Ответ 8

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

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

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