Zobrazenie komentárov XML na novom riadku

Vo Visual Studiu môžete písať xml komentáre k dokumentu C# a VB.NET vlastnosti a metódy. Po jeho napísaní budete môcť zobraziť popis vlastnosti alebo metódy, keď ju napíšete v kóde, umiestniť kurzor myši a použiť nástroj, ako napríklad "Sandcastle".

Ak však napíšete príliš veľa, čitateľnosť sa zníži, takže to zvyčajne napíšete asi v jednom riadku, ale v niektorých prípadoch ho možno budete chcieť zobraziť na viacerých riadkoch.

Ak prelomíte riadok v komentári normálne, budete očakávať, že sa zobrazí s prerušením riadka, keď sa zobrazí popis, ale keď to skutočne vyskúšate, zobrazí sa nasledovne.

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

Výsledok zobrazenia vysvetlenia

V texte popisu nie sú žiadne zlomy riadkov a rozloženie vyzerá, akoby obsahovalo medzery. XML má rôzny vplyv na to, ako sa spracováva medzery a zlomy riadkov, a Visual Studio nepovažuje normálne zlomy riadkov za zlomy textu.

Ak teda chcete rozbiť text popisu na riadku, ako to urobiť, je použiť značku "para". "para" znamená "odsek". Uzavrite jednotky, ktoré chcete prelomiť takéto riadky, do značky para:

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

Popis je zobrazený s zlomom riadka, ako je znázornené na obrázku. Ak použijete nástroj na generovanie dokumentov, zobrazí sa aj ako odsek so zlomami riadkov.