Zobrazení komentářů XML na novém řádku

V aplikaci Visual Studio můžete psát komentáře k dokumentům XML v jazyce C# a VB.NET vlastnosti a metody. Jakmile jej napíšete, budete moci zobrazit popis vlastnosti nebo metody, když ji napíšete v kódu, umístíte kurzor myši a použijete nástroj, jako je "Sandcastle".

Pokud však píšete příliš mnoho, čitelnost se sníží, takže obvykle ji napíšete asi v jednom řádku, ale v některých případech ji možná budete chtít zobrazit na více řádcích.

Pokud normálně zalomíte řádek v komentáři, budete očekávat, že se při zobrazení popisu zobrazí se zalomením řádku, ale když to skutečně zkusíte, zobrazí se následujícím způsobem.

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

Výsledek zobrazení vysvětlení

V textu popisu nejsou žádné konce řádků a rozložení vypadá, jako by obsahovalo mezery. XML má různý vliv na to, jak jsou zpracovány prázdné znaky a konce řádků a Visual Studio nepovažuje normální konce řádků za konce textu.

Pokud tedy chcete přerušit popisný text na řádku, jak to udělat, je použít značku "para". "para" znamená "odstavec". Jednotky, které chcete přerušovat řádky, uzavřete do značky para:

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

Popis se zobrazí se zalomením řádku, jak je znázorněno na obrázku. Pokud použijete nástroj pro generování dokumentu, zobrazí se také jako odstavec se zalomením řádků.