NewLine en el resumen del objeto


98

Saludos

Al configurar un resumen para una propiedad / campo / método, etc., ¿es posible tener una nueva línea en él?

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

Cuando configuro esto, se muestra 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 \npero no funciona. ¿Hay alguna forma de hacer esto?

Respuestas:


186

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; }

1
@YetAnotherUser, ¿qué pasa con una línea en blanco?
Behzad

1
@Behzad intente usar <para>&nbsp;</para>.
YetAnotherUser

15
Odio esas líneas adicionales :(
Jan Macháček

10
En el IDE de Visual Studio 2017, la "solución" anterior en realidad muestra una LÍNEA EN BLANCO solitaria entre la línea 1 y la línea 2 (es decir, una nueva línea después de la línea 1 seguida de una línea en blanco y luego la línea 2); esto no es lo mismo nueva línea, como solicitó el OP. ¿Es eso un error en el IDE de VS 2017, o todos los que votaron no ven que esta respuesta no produce lo que el OP muestra como el resultado deseado?
Jazimov

Ese es un nuevo párrafo, no una nueva línea. Me parece que la sintaxis de la documentación es algo limitante.
GrizzlyMcBear

33

Si:

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

12

Este puede ser un hilo antiguo, pero estaba buscando una respuesta mientras usaba Visual Studio 2019 . Quería párrafos y saltos de línea. Lo siguiente funciona bien para mí:

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

Produce lo siguiente:

parameter name="guidType" options:

0 = SequentialAsString
1 = SequentialAsBinary
2 = SequentialAtEnd

4
Para VS2019 y posteriores, esta respuesta es técnicamente más correcta que la respuesta aceptada.
Riaan Walters

También puede usar <br /> solo al final de la línea en VS2019. Estas soluciones producen un salto de línea real y no un nuevo párrafo con una línea vacía. Gracias
Phillip S

5

Se puede utilizar <para />para agregar una nueva línea dentro del resumen:

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

Parece:

Main comment
Line 1
Line 2

¡Atentamente!


2

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

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

Esto da el siguiente resultado:

Summary  
Main summary line.

Your secondary summary

1

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

así que lo siguiente

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

se convierte en

    /// <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? - usando una configuración especial, el comentario de domaindrivendev, https://github.com/domaindrivendev/Swashbuckle/issues/258 - sobre el <br/>uso.


0

Puede agregar legítimamente etiquetas para, pero esto en realidad crea un nuevo párrafo para cada nueva línea y el interlineado aparece apagado.
Personalmente agrego 1 párrafo alrededor del párrafo y luego bretiquetas al final de las líneas en las que quería un descanso, lo que conserva un espaciado de línea decente:

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

3
Esto no funciona y no hay nada de malo en el espaciado con <para>. ¿Qué versión de VS / .Net estás usando?
Dani

2
Las etiquetas HTML serán ignoradas por summary, incluso si están dentro de la paraetiqueta.
Lázaro Fernandes Lima Suleiman

-7

Sugeriría usar este formato si desea 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 creará una nueva línea donde también está la etiqueta).

Sin embargo, tenga en cuenta que si tiene un espacio después de la etiqueta <br />, obtendrá un espacio adicional en la siguiente línea. Por lo tanto, desea tener la misma cantidad de espacio en cada línea, por lo que cada fila estará 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; }

3
Lo primero que intenté antes de buscar una solución porque eso no funciona.
Philippe

Funciona para mí también. Votación a favor
AlexWei
Al usar nuestro sitio, usted reconoce que ha leído y comprende nuestra Política de Cookies y Política de Privacidad.
Licensed under cc by-sa 3.0 with attribution required.