Pour afficher des commentaires XML sur une nouvelle ligne

Dans Visual Studio, vous pouvez écrire des commentaires de document XML en C# et VB.NET propriétés et méthodes. Une fois que vous l’avez écrit, vous pourrez afficher la description de la propriété ou de la méthode lorsque vous l’écrivez dans le code, passez le curseur de la souris et utilisez un outil tel que « Sandcastle ».

Cependant, si vous écrivez trop, la lisibilité diminuera, donc généralement vous l’écrirez sur environ une ligne, mais dans certains cas, vous voudrez peut-être l’afficher sur plusieurs lignes.

Si vous sautez une ligne dans un commentaire normalement, vous vous attendez à ce qu’elle soit affichée avec un saut de ligne lorsque la description est affichée, mais lorsque vous l’essayez réellement, elle sera affichée comme suit.

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

Explication du résultat de l’affichage

Il n’y a pas de sauts de ligne dans le texte de description et la mise en page semble contenir des espaces. XML a un effet variable sur la façon dont les espaces blancs et les sauts de ligne sont gérés, et Visual Studio ne considère pas les sauts de ligne normaux comme des sauts de texte.

Donc, si vous voulez casser le texte de description sur une ligne, comment le faire est d’utiliser la balise « para ». « para » signifie « paragraphe ». Placez les unités que vous souhaitez casser des lignes comme ceci dans une balise para :

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

La description s’affiche avec un saut de ligne comme illustré dans la figure. Si vous utilisez l’outil de génération de documents, il apparaîtra également sous la forme d’un paragraphe avec des sauts de ligne.