web-dev-qa-db-fra.com

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 dedans?

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

Lorsque je le configure, il apparaît comme sur la souris:

bool TestLine
This is line 1 This is line 2

Mais je veux que cela se présente comme:

bool TestLine
This is line 1 
This is line 2

J'ai essayé d'utiliser \n mais cela ne fonctionne pas. Existe-t-il un moyen d'y parvenir?

c#newlinesummary
87
Theun Arbeider

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; }
170
YetAnotherUser

Oui:

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

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!

3
fdelgado

J'ajoute juste ceci pour toute personne utilisant Xamarin Studio comme je le suis. J'ai trouvé qu'aucune des solutions ci-dessus ne fonctionnait pour moi, mais celle-ci a:

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

Cela donne la sortie suivante:

Summary  
Main summary line.

Your secondary summary
2
head in the codes

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/> pourrait également être utilisé.

donc ce qui suit

    /// <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 de Swashbuckle? - en utilisant une configuration spéciale, commentaire de domaindrivendev, https://github.com/domaindrivendev/Swashbuckle/issues/ 258 - le <br/> utilisation.

1
Dmitry Karpenko

Il s'agit peut-être d'un ancien thread, mais je cherchais une réponse lors de l'utilisation de Visual Studio 2019. Je voulais des sauts de paragraphe et de ligne. 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 les éléments suivants:

parameter name="guidType" options:

0 = SequentialAsString
1 = SequentialAsBinary
2 = SequentialAtEnd
0
Thomas Cayne