Så här visar du XML-kommentarer på en ny rad

I Visual Studio kan du skriva XML-dokumentkommentarer på C# och VB.NET egenskaper och metoder. När du har skrivit det kommer du att kunna se beskrivningen av egenskapen eller metoden när du skriver den i kod, håll muspekaren och använd ett verktyg som "Sandcastle".

Men om du skriver för mycket kommer läsbarheten att minska, så vanligtvis skriver du det på ungefär en rad, men i vissa fall kanske du vill visa det på flera rader.

Om du bryter en rad i en kommentar normalt förväntar du dig att den visas med en radbrytning när beskrivningen visas, men när du faktiskt försöker kommer den att visas enligt följande.

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

Förklaring visningsresultat

Det finns inga radbrytningar i beskrivningstexten och layouten ser ut som om den innehåller blanksteg. XML har en varierande effekt på hur blanksteg och radbrytningar hanteras, och Visual Studio betraktar inte normala radbrytningar som textbrytningar.

Så om du vill bryta beskrivningstexten på en rad, hur man gör det är att använda "para" -taggen. "para" står för "stycke". Bifoga de enheter du vill bryta linjer så här i en para-tagg:

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

Beskrivningen visas med en radbrytning som visas i figuren. Om du använder dokumentgenereringsverktyget visas det också som ett stycke med radbrytningar.