Sådan vises XML-kommentarer på en ny linje

I Visual Studio kan du skrive XML-dokumentkommentarer til C# og VB.NET egenskaber og metoder. Når du har skrevet det, vil du være i stand til at se beskrivelsen af ejendommen eller metoden, når du skriver den i kode, holde musemarkøren og bruge et værktøj som "Sandcastle".

Men hvis du skriver for meget, vil læsbarheden falde, så normalt vil du skrive det på omkring en linje, men i nogle tilfælde vil du måske vise det på flere linjer.

Hvis du bryder en linje i en kommentar normalt, forventer du, at den vises med et linjeskift, når beskrivelsen vises, men når du rent faktisk prøver den, vises den som følger.

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

Forklaringsvisning resultat

Der er ingen linjeskift i beskrivelsesteksten, og layoutet ser ud som om det indeholder mellemrum. XML har en varierende effekt på, hvordan mellemrum og linjeskift håndteres, og Visual Studio betragter ikke normale linjeskift som tekstskift.

Så hvis du vil bryde beskrivelsesteksten på en linje, hvordan du gør det, er at bruge "para" -tagget. "para" står for "afsnit". Vedlæg de enheder, du vil bryde linjer som denne, i et para-tag:

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

Beskrivelsen vises med et linjeskift som vist i figuren. Hvis du bruger dokumentgenereringsværktøjet, vises det også som et afsnit med linjeskift.