method - returns c#

NewLine en resumen de objetos

Question

Saludos

Cuando se establece un resumen para una propiedad / campo / método, etc. ¿es posible tener una nueva línea?

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

Cuando configuro esto, aparece como al pasar el mouse sobre:

bool TestLine
This is line 1 This is line 2

Pero quiero que se muestre como:

bool TestLine
This is line 1 
This is line 2

He intentado usar /n pero eso no funciona. ¿Hay alguna manera de hacer esto?

Answer 1

Puede legítimamente agregar etiquetas para, pero esto realmente crea un nuevo párrafo para cada nueva línea y el espaciado entre líneas aparece desactivado.
Personalmente, agregué 1 párrafo alrededor del párrafo y luego br etiquetas al final de las líneas que quería un descanso, que conserva un espacio de línea decente:

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

Answer 2

Quieres usar algo como esto

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

Answer 3

Sí:

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

Answer 4

Si está utilizando Swashbuckle (biblioteca de integración Swagger Web API), entonces <para></para> debería reemplazarse por <p></p> y <br/> también podría usarse.

entonces el siguiente

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

se convierte

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

El problema ya se describe aquí: ¿Cómo agregar un salto de línea a la documentación de Swashbuckle? - utilizando una configuración especial, el comentario de domaindrivendev, https://github.com/domaindrivendev/Swashbuckle/issues/258 - en <br/> uso.

Answer 5

Solo estoy agregando esto para cualquiera que use Xamarin Studio como yo. Descubrí que ninguna de las soluciones anteriores funciona para mí, pero esta sí lo hizo:

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

Esto da el siguiente resultado:

Summary  
Main summary line.

Your secondary summary

Answer 6

Sugeriría usar este formato si quieres varias líneas en el resumen sin complicarlo. Funcionará si usa la etiqueta <br /> después de cada línea. (usarlo en cualquier lugar dentro del texto hará una nueva línea donde también esté la etiqueta).

Aunque tenga en cuenta que si tiene un espacio después de la etiqueta <br />, obtendrá un espacio extra en la siguiente línea. Así que quieres tener la misma cantidad de espacio en cada línea, por lo que cada fila será en línea recta.

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