Per mostrar comentaris XML en una línia nova

A Visual Studio, podeu escriure comentaris de documents XML sobre C# i VB.NET propietats i mètodes. Un cop l'escriviu, podreu veure la descripció de la propietat o mètode quan l'escriviu en codi, passeu el cursor del ratolí i utilitzeu una eina com ara "Sandcastle".

Tanmateix, si escriviu massa, la llegibilitat disminuirà, de manera que normalment l'escriureu en aproximadament una línia, però en alguns casos és possible que vulgueu mostrar-la en diverses línies.

Si trenqueu una línia en un comentari normalment, esperareu que es mostri amb un salt de línia quan es mostri la descripció, però quan realment ho proveu, es mostrarà de la manera següent.

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

Resultat de la visualització de l'explicació

No hi ha salts de línia en el text de la descripció i el disseny sembla com si contingués espais. XML té un efecte variable en com es gestionen els salts d'espai en blanc i de línia, i Visual Studio no considera que els salts de línia normals siguin salts de text.

Per tant, si voleu trencar el text de descripció en una línia, la manera de fer-ho és utilitzar l'etiqueta "para". "para" significa "paràgraf". Adjunteu les unitats que voleu trencar línies com aquesta en una etiqueta para:

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

La descripció es mostra amb un salt de línia tal com es mostra a la figura. Si utilitzeu l'eina de generació de documents, també apareixerà com a paràgraf amb salts de línia.