Come aggiungere un'interruzione di riga nella documentazione di C # .NET


196

Questo dovrebbe essere più facile ...

Voglio aggiungere un'interruzione di riga "codificata" alla documentazione XML nel mio codice

/// <summary>
/// Get a human-readable variant of the SQL WHERE statement of the search element. &lt;br/&gt;
/// Rather than return SQL, this method returns a string with icon-tokens, which 
/// could be used to represent the search in a condensed pictogram format.
/// </summary>

Come puoi vedere, ho trovato alcune risposte che hanno dimostrato l'aggiunta di parentesi <e>. È interessante notare che la buona interruzione di riga 'ol <br /> non crea un'interruzione di linea nel popup Intellisense.

Lo trovo fastidioso ...

Eventuali suggerimenti?


3
È possibile utilizzare <br/> per creare interruzioni di linea a partire da Visual Studio 2019. Fare riferimento qui alla risposta .
23bl

Risposte:


314

Puoi usare un <para />tag per produrre un'interruzione di paragrafo oppure puoi racchiudere il testo nei <para></para>tag come un modo per raggruppare il testo e aggiungere la riga vuota dopo di esso, ma non esiste un equivalente <br />o qualcosa del genere. (Che secondo questo vecchio post sul forum MS è in base alla progettazione.) Puoi ottenere l'elenco dei tag disponibili in questo articolo di documentazione da MS. Documentare il tuo codice

Esempio (basato sul campione OP originale):

/// <summary>
/// <para>Get a human-readable variant of the SQL WHERE statement of the search element.</para>
/// Rather than return SQL, this method returns a string with icon-tokens, which 
/// could be used to represent the search in a condensed pictogram format.
/// </summary>

5
Aha! Adesso stavano cucinando! Grazie! Questo mi ha infastidito da molto tempo ormai ... Ho visto l'opzione para elencata, ma ho pensato che fosse una scorciatoia "paramater".
Tinkerer_CardTracker

2
Non ha funzionato per me. Usando VB.NET su VS 2010, provato con e senza l'opzione di parametro colorato di Powertools, i <para>tag vengono ignorati e tutto viene miscelato in un'unica riga in Intellisense. Ho trovato questa domanda, in cui Hans ha spiegato il problema: stackoverflow.com/questions/7070737/… .
Neolisk,

1
Assicurati di aggiungere anche il tag </para> di chiusura =)
link64

85
La cosa negativa di questo è che in realtà aggiunge un'intera riga vuota, anziché solo una nuova riga.
Devid

6
Qualcuno ha trovato un modo per inserire effettivamente una riga anziché due?

75

Questo è il mio utilizzo, tipo <br/>, funziona :)

/// <summary>
/// Value: 0/1/2
/// <para/>0 foo,
/// <para/>1 bar,
/// <para/>2 other
/// </summary>

8
Perché questa risposta è stata sottoposta a downgrade? Funziona, e sembra essere una soluzione molto migliore rispetto all'utilizzo <para>&#160;</para>, <para>&nbsp;</para>o il personaggio invisibile ...
Dinei

Questo funziona per le nuove righe, ma non inserisce una riga vuota tra le cose come fanno le altre opzioni.
Yushatak,

15
Nelle versioni recenti di VS <para/>sembra aggiungere una riga vuota, non solo un'interruzione di riga.
Dinei,

2
@IlPADlI, +1 per esempio d'uso. Confermato il lavoro su VS 2012 Ultimate Update 5.
Dennis T - Ripristina Monica -

9
VS 2017: aggiunta riga vuota, non semplicemente interruzione di riga ... microsoft sicuramente ama dirci cosa vogliamo fare ...
Assimilater,

39

A partire da Visual Studio 2019, utilizzare <br/>per le nuove righe nei commenti.

Esempio:

/// <summary>
/// This is a comment.<br/>
/// This is another comment <br/>
/// This is a long comment so i want it to continue <br/> on another line.
/// </summary>

inserisci qui la descrizione dell'immagine

Si noti che non viene aggiunta alcuna riga aggiuntiva quando si utilizza <br/>invece di <para>.


4
Ancora utile perché questa domanda è il miglior risultato di Google per come aggiungere un'interruzione di riga nella documentazione di C #.
Dan,

27

Aggiungi un <para>tag con un carattere speciale al suo interno, il 255 carattere o il carattere invisibile .

/// <summary>
/// Some text
/// <para>   </para>
/// More text
/// </summary>
/// <param name="str">Some string</param>
public void SomeMethod(string str) { }

Funzionerà così:

inserisci qui la descrizione dell'immagine


8
Questo è utile, tuttavia &nbsp;non funziona, invece usa/// <para>&#160;</para>
Robert H

1
Personalmente tengo /// <para> </para>una nota adesiva. Quindi è solo copia e incolla! (E funziona - almeno per me)
Joel

2
Non so perché, ma copia incolla /// <para> </para>non funziona affatto. /// <para>&#160;</para>lavori!
Wenqiang,

8
Invece di usare il <para>tag tra blocchi di testo, dovresti usare il <para>tag attorno a tutti i paragrafi tranne il primo <summary>nell'elemento. Per i <typeparam>, <param>, <value>, <exception>, e <returns>gli elementi, li usa in giro tutti i paragrafi, se si dispone di più di uno (facoltativo se si dispone di un solo di questi elementi). Per tutti gli altri elementi di blocco (incluso <note>all'interno di un altro elemento di blocco), usa i <para>tag attorno a tutti i paragrafi, anche se ne hai solo uno.
Sam Harwell,

1
Fonte: ho creato questo, inclusa la maggior parte dello stile di presentazione: openstacknetsdk.org/docs-master/html/…
Sam Harwell,

3

<br></br>e <br />non sembrano funzionare, e talvolta non si tratta in realtà di <para>separare le frasi tanto quanto il desiderio di avere una linea vuota per la separazione delle preoccupazioni. Lo menziono qui perché questa domanda sembra essere genitore di molte domande chiuse di questa natura.

L'unica cosa che ho scoperto di funzionare è stata

<para>&#160;</para>

Per esempio

/// <summary>
///     <para>
///         "This sentence shows up when the type is hovered"
///     </para>
///     <para>&#160;</para>
///     <para>int PrimaryKey</para>
///     <para>&#160;</para>
///     <para>virtual Relation Relation</para>
/// </summary>

Risultati in

"This sentence shows up when the type is hovered"

int PrimaryKey

virtual Relation Relation
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.