XML komentarų rodymas naujoje eilutėje

"Visual Studio" galite rašyti XML dokumentų komentarus apie C# ir VB.NET ypatybes bei metodus. Kai jį parašysite, galėsite peržiūrėti ypatybės ar metodo aprašymą, kai jį rašysite kodu, užveskite pelės žymeklį ir naudokite tokį įrankį kaip "Sandcastle".

Tačiau jei rašysite per daug, skaitomumas sumažės, todėl paprastai jį parašysite maždaug vienoje eilutėje, tačiau kai kuriais atvejais galbūt norėsite jį rodyti keliose eilutėse.

Jei komentare paprastai sulaužysite eilutę, tikitės, kad ji bus rodoma su eilutės lūžiu, kai bus rodomas aprašas, bet kai iš tikrųjų išbandysite, ji bus rodoma taip.

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

Paaiškinimo rodymo rezultatas

Aprašo tekste nėra eilučių lūžių, o maketas atrodo taip, lyg jame būtų tarpų. XML turi skirtingą poveikį tam, kaip tvarkomi tarpai ir eilučių lūžiai, o "Visual Studio" nemano, kad įprasti eilučių lūžiai yra teksto lūžiai.

Taigi, jei norite sulaužyti aprašymo tekstą eilutėje, kaip tai padaryti, naudokite žymą "para". "para" reiškia "pastraipa". Pridėkite vienetus, kuriuos norite sulaužyti tokias linijas, į para žymą:

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

Aprašas rodomas su eilutės lūžiu, kaip parodyta paveikslėlyje. Jei naudojate dokumentų generavimo įrankį, jis taip pat bus rodomas kaip pastraipa su eilučių lūžiais.