NewLine nel riepilogo degli oggetti


99

Saluti

Quando si imposta un riepilogo per una proprietà / campo / metodo ecc., È possibile inserire una nuova riga?

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

Quando lo imposto, viene visualizzato come al passaggio del mouse:

bool TestLine
This is line 1 This is line 2

Ma voglio che si mostri come:

bool TestLine
This is line 1 
This is line 2

Ho provato a usare \nma non funziona. C'è un modo per farlo?

Risposte:


188

Vuoi usare qualcosa di simile

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

1
@YetAnotherUser, che ne dici di una riga vuota?
Behzad

1
@ Behzad prova a usare <para>&nbsp;</para>.
YetAnotherUser

10
Nell'IDE di Visual Studio 2017, la "soluzione" di cui sopra visualizza effettivamente una LINEA VUOTA solitaria tra la riga 1 e la riga 2 (ovvero, una nuova riga dopo la riga 1 seguita da una riga vuota e poi la riga 2) - questo non è lo stesso a nuova riga, come richiesto dall'OP. È un bug nell'IDE VS 2017 - o tutti coloro che hanno votato in alto non vedono che questa risposta non produce ciò che l'OP mostra come output desiderato?
Jazimov

Questo è un nuovo paragrafo, non una nuova riga. Mi sembra che la sintassi della documentazione sia in qualche modo limitante.
GrizzlyMcBear

33

Sì:

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

14

Potrebbe essere un vecchio thread, ma stavo cercando una risposta durante l'utilizzo di Visual Studio 2019 . Volevo interruzioni di paragrafo e di riga. Quanto segue funziona bene per me:

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

Produce quanto segue:

parameter name="guidType" options:

0 = SequentialAsString
1 = SequentialAsBinary
2 = SequentialAtEnd

4
Per VS2019 e successivi, questa risposta è tecnicamente più corretta della risposta accettata.
Riaan Walters,

Puoi anche usare <br /> solo alla fine della riga in VS2019. Queste soluzioni producono un'interruzione di riga effettiva e non un nuovo paragrafo con una riga vuota! Grazie
Phillip S

5

Puoi utilizzare <para />per aggiungere una nuova riga nel riepilogo:

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

Sembra:

Main comment
Line 1
Line 2

I migliori saluti!


2

Lo sto solo aggiungendo per chiunque utilizzi Xamarin Studio come me. Ho scoperto che nessuna delle soluzioni di cui sopra funziona per me, ma questa ha funzionato:

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

Questo dà il seguente output:

Summary  
Main summary line.

Your secondary summary

1

Se stai usando Swashbuckle (libreria di integrazione dell'API Web Swagger), allora <para></para>dovrebbe essere sostituito con <p></p>e <br/>potrebbe anche essere usato.

quindi il seguente

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

diventa

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

Il problema è già descritto qui: come aggiungere un'interruzione di riga alla documentazione di Swashbuckle? - utilizzando una configurazione speciale, il commento di domaindrivendev, https://github.com/domaindrivendev/Swashbuckle/issues/258 - <br/>sull'utilizzo.


0

Puoi legittimamente aggiungere tag para, ma questo in realtà crea un nuovo paragrafo per ogni nuova riga e l'interlinea appare disattivata.
Personalmente aggiungo 1 para attorno al paragrafo e poi i brtag alla fine delle righe su cui volevo un'interruzione, che preserva una spaziatura decente:

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

3
Questo non funziona e non c'è niente di strano sulla spaziatura con <para>. Quale versione di VS / .Net stai usando?
Dani

2
I tag HTML verranno ignorati da summary, anche se si trovano all'interno del paratag.
Lazaro Fernandes Lima Suleiman

-7

Suggerirei di utilizzare questa formattazione se si desidera più righe nel riepilogo senza complicarlo. Funzionerà se utilizzi il tag <br /> dopo ogni riga. (usandolo ovunque all'interno del testo creerà una nuova riga dove si trova anche il tag.)

Tuttavia, tieni presente che se hai uno spazio dopo il tag <br />, otterrai uno spazio extra nella riga successiva. Quindi vuoi avere la stessa quantità di spazio su ogni riga, quindi ogni riga sarà in linea retta.

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

3
La prima cosa che ho provato prima di cercare una soluzione perché non funziona!
Philippe
Utilizzando il nostro sito, riconosci di aver letto e compreso le nostre Informativa sui cookie e Informativa sulla privacy.
Licensed under cc by-sa 3.0 with attribution required.