Per visualizzare commenti XML su una nuova riga

In Visual Studio è possibile scrivere commenti sui documenti XML in C# e VB.NET proprietà e metodi. Una volta scritto, sarai in grado di visualizzare la descrizione della proprietà o del metodo quando lo scrivi nel codice, passa il cursore del mouse e usi uno strumento come "Sandcastle".

Tuttavia, se scrivi troppo, la leggibilità diminuirà, quindi di solito lo scriverai in circa una riga, ma in alcuni casi potresti volerlo visualizzare su più righe.

Se interrompi normalmente una riga in un commento, ti aspetteresti che venga visualizzata con un'interruzione di riga quando viene visualizzata la descrizione, ma quando la provi effettivamente, verrà visualizzata come segue.

/// <summary>
/// これは
/// 普通に
/// 改行したもの
/// <summary>
public int Amount1 { get; set; }

Risultato di visualizzazione della spiegazione

Non ci sono interruzioni di riga nel testo della descrizione e il layout sembra contenere spazi. XML ha un effetto variabile sulla modalità di gestione degli spazi vuoti e delle interruzioni di riga e Visual Studio non considera le normali interruzioni di riga come interruzioni di testo.

Quindi, se vuoi rompere il testo della descrizione su una riga, come farlo è usare il tag "para". "para" sta per "paragrafo". Racchiudere le unità che si desidera interrompere le linee in questo modo in un tag para:

/// <summary>
/// <para>paraを</para>
/// <para>使って</para>
/// <para>改行したもの</para>
/// </summary>
public int Amount2 { get; set; }

La descrizione viene visualizzata con un'interruzione di riga, come illustrato nella figura. Se si utilizza lo strumento di generazione del documento, verrà visualizzato anche come paragrafo con interruzioni di riga.