NewLine dans le résumé de l'objet

Salutations

Lors de la définition d'un résumé pour une propriété / un champ / une méthode, etc., est-il possible d'avoir une nouvelle ligne?

/// <summary>
/// This is line 1
/// This is line 2
/// </summary>
public bool TestLine { get; set; }

Lorsque je définis cela, cela s'affiche comme au survol de la souris:

bool TestLine
This is line 1 This is line 2

Mais je veux que cela apparaisse comme:

bool TestLine
This is line 1 
This is line 2

J'ai essayé d'utiliser \nmais cela ne fonctionne pas. Y a-t-il un moyen d'y parvenir?

Vous voulez utiliser quelque chose comme ça

/// <summary> 
/// Your Main comment 
/// <para>This is line 1</para> 
/// <para>This is line 2</para> 
/// </summary> 
public bool TestLine { get; set; }

Oui:

/// <summary> 
/// Main comment 
/// <para>Line 1</para> 
/// <para>Line 2</para> 
/// </summary> 
public bool TestLine { get; set; }

Cela peut être un ancien fil de discussion, mais je cherchais une réponse lors de l'utilisation de Visual Studio 2019 . Je voulais des sauts de paragraphes et de lignes. Ce qui suit fonctionne bien pour moi:

/// <summary>
/// <para>parameter name="guidType" options:</para>
/// <br>0 = SequentialAsString</br>
/// <br>1 = SequentialAsBinary</br>
/// <br>2 = SequentialAtEnd</br>
/// </summary>

Produit ce qui suit:

parameter name="guidType" options:

0 = SequentialAsString
1 = SequentialAsBinary
2 = SequentialAtEnd

Vous pouvez utiliser <para />pour ajouter une nouvelle ligne dans le résumé:

/// <summary> 
/// Main comment<para />
/// Line 1<para />
/// Line 2<para />
/// </summary>
public bool TestLine { get; set; }

Ressemble à:

Main comment
Line 1
Line 2

Meilleures salutations!

J'ajoute simplement ceci pour tous ceux qui utilisent Xamarin Studio comme moi. J'ai trouvé qu'aucune des solutions ci-dessus ne fonctionne pour moi, mais celle-ci a fonctionné:

/// <summary>
/// Main summarry line.
/// <para></para>
/// <para></para>
/// Your secondary summary
/// </summary>

Cela donne la sortie suivante:

Summary  
Main summary line.

Your secondary summary

Si vous utilisez Swashbuckle (bibliothèque d'intégration de l'API Web Swagger), alors <para></para>doit être remplacé par <p></p>et <br/>peut également être utilisé.

donc le suivant

    /// <para>
    ///     Flag1, Flag2
    ///     - bool flags, optional.
    /// </para>

devient

    /// <p>
    ///     Flag1, Flag2<br/>
    ///     - bool flags, optional.
    /// </p>

Le problème est déjà décrit ici: Comment ajouter un saut de ligne à la documentation Swashbuckle? - en utilisant une configuration spéciale, le commentaire de domaindrivendev, https://github.com/domaindrivendev/Swashbuckle/issues/258 - sur l' <br/>utilisation.

Vous pouvez légitimement ajouter des balises para, mais cela crée en fait un nouveau paragraphe pour chaque nouvelle ligne et l'interligne est désactivé.
Personnellement, j'ajoute 1 paragraphe autour du paragraphe, puis des brbalises à la fin des lignes sur lesquelles je voulais une pause, ce qui préserve un interligne décent:

/// <summary> 
/// <para>Main comment<br /> 
/// Line 1<br />
/// Line 2</para> 
/// </summary>
public bool TestLine { get; set; }

Je suggérerais d'utiliser ce formatage si vous voulez plusieurs lignes dans le résumé sans le compliquer. Cela fonctionnera si vous utilisez la balise <br /> après chaque ligne. (l'utiliser n'importe où dans le texte créera une nouvelle ligne où se trouve également la balise.)

Cependant, notez que si vous avez un espace après la balise <br />, vous obtiendrez un espace supplémentaire sur la ligne suivante. Donc vous voulez avoir la même quantité d'espace sur chaque ligne, donc chaque ligne sera en ligne droite.

/// <summary>
/// This is line 1<br />
/// This is line 2<br />
/// This is line 3<br />
/// </summary>
public bool TestLine { get; set; }