XML-kommentaaride kuvamine uuel real

Visual Studios saate kirjutada XML-dokumendi kommentaare C# ja VB.NET omaduste ja meetodite kohta. Kui olete selle kirjutanud, saate vaadata vara või meetodi kirjeldust, kui kirjutate selle koodi, hõljutate hiirekursorit ja kasutate sellist tööriista nagu "Sandcastle".

Kui aga kirjutate liiga palju, väheneb loetavus, nii et tavaliselt kirjutate selle umbes ühele reale, kuid mõnel juhul võiksite selle kuvada mitmel real.

Kui katkestate kommentaaris rea tavaliselt, eeldate, et see kuvatakse kirjelduse kuvamisel reavahetusega, kuid kui te seda tegelikult proovite, kuvatakse see järgmiselt.

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

Selgituse kuvamise tulemus

Kirjeldavas tekstis pole reapiire ja paigutus näeb välja nii, nagu sisaldaks see tühikuid. XML-il on erinev mõju sellele, kuidas tühikut ja reapiire käsitletakse, ning Visual Studio ei pea tavalisi reavahetusi tekstipiirideks.

Niisiis, kui soovite kirjelduse teksti real murda, siis kuidas seda teha, on kasutada silti "para". "para" tähistab "lõiget". Lisage ühikud, mida soovite katkestada, para-sildile järgmiselt:

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

Kirjeldus kuvatakse reavahetusega, nagu on näidatud joonisel. Kui kasutate dokumendi genereerimise tööriista, kuvatakse see ka reapiiridega lõiguna.