XML-opmerkingen weergeven op een nieuwe regel

In Visual Studio kunt u XML-documentopmerkingen schrijven op C# en VB.NET eigenschappen en methoden. Zodra u het schrijft, kunt u de beschrijving van de eigenschap of methode bekijken wanneer u deze in code schrijft, de muiscursor beweegt en een tool zoals "Sandcastle" gebruikt.

Als u echter te veel schrijft, neemt de leesbaarheid af, dus meestal schrijft u het in ongeveer één regel, maar in sommige gevallen wilt u het misschien op meerdere regels weergeven.

Als u een regel in een opmerking normaal afbreekt, verwacht u dat deze wordt weergegeven met een regeleinde wanneer de beschrijving wordt weergegeven, maar wanneer u deze daadwerkelijk probeert, wordt deze als volgt weergegeven.

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

Uitleg weergave resultaat

Er zijn geen regeleinden in de beschrijvingstekst en de lay-out ziet eruit alsof deze spaties bevat. XML heeft een wisselend effect op de manier waarop witruimte en regeleinden worden verwerkt en Visual Studio beschouwt normale regeleinden niet als teksteinden.

Dus als u de beschrijvingstekst op een regel wilt breken, kunt u de tag "para" gebruiken. "para" staat voor "alinea". Sluit de eenheden die u wilt breken lijnen zoals deze in een para-tag:

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

De beschrijving wordt weergegeven met een regeleinde zoals weergegeven in de afbeelding. Als u het hulpprogramma voor het genereren van documenten gebruikt, wordt het ook weergegeven als een alinea met regeleinden.