XML-megjegyzések megjelenítése új sorban

A Visual Studióban XML-dokumentumokkal kapcsolatos megjegyzéseket írhat a C#-ról, és VB.NET tulajdonságokat és metódusokat. Miután megírta, megtekintheti a tulajdonság vagy módszer leírását, amikor kódba írja, vigye az egérmutatót, és használjon olyan eszközt, mint a "Sandcastle".

Ha azonban túl sokat ír, az olvashatóság csökken, ezért általában körülbelül egy sorba írja be, de bizonyos esetekben érdemes több sorban megjeleníteni.

Ha normálisan megszakít egy sort egy megjegyzésben, akkor elvárja, hogy sortöréssel jelenjen meg, amikor a leírás megjelenik, de amikor ténylegesen kipróbálja, akkor az a következőképpen jelenik meg.

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

Magyarázat megjelenítési eredménye

A leíró szövegben nincsenek sortörések, és az elrendezés úgy néz ki, mintha szóközöket tartalmazna. Az XML-fájl eltérő hatással van a szóközök és a sortörések kezelésére, és a Visual Studio nem tekinti a normál sortöréseket szövegtörésnek.

Tehát, ha meg akarja szakítani a leírás szövegét egy sorban, akkor ezt úgy kell megtenni, hogy használja a "para" címkét. A "para" a "bekezdést" jelenti. Az ilyen sorokat törni kívánt egységeket egy paracímkébe tegye:

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

A leírás sortöréssel jelenik meg az ábrán látható módon. Ha a dokumentumgeneráló eszközt használja, az sortörésekkel rendelkező bekezdésként is megjelenik.