de style + contrôle de ReSharper commentaires

Question

cela peut sembler une question triviale, mais quand je l'ai installé le plugin StyleCop pour ReSharper mes commentaires sont se forme comme celui-ci

/// <summary> 
/// Gets the gift item. 
/// </summary> 
/// <param name="uid"> 
/// The uid. 
/// </param> 
/// <param name="upc"> 
/// The upc. 
/// </param> 
/// <returns> 
/// </returns> 
Gift GetGift(long uid, string upc); 

par opposition à

/// <summary>Gets the gift item.</summary> 
/// <param name="uid">The uid.</param> 
/// <param name="upc">The upc.</param> 
/// <returns></returns> 
Gift GetGift(long uid, string upc); 

I n'arrive pas à trouver un moyen de désactiver ce type de formatage.

Answer 1

Donnez GhostDoc un essai. Cette extension Visual Studio gratuite génère des commentaires doc XML encore plus agréable. param et return les étiquettes sont en ligne tandis que les étiquettes summary restent sur des lignes séparées. Peut-être que cela correspond déjà à vos besoins.

Answer 2

Vous pouvez faire fonctionner GhostDoc si vous désactivez "Reformater les commentaires de document XML incorporés" dans vos paramètres de nettoyage de code par défaut dans la catégorie "C#". Ensuite, sous la section StyleCop, désactivez la règle "1611: Les paramètres d'élément doivent être documentés" et la règle "1618: Les paramètres de type générique doivent être documentés". De cette façon, le nettoyage du code ne remodèlera pas vos commentaires GhostDoc. Gardez à l'esprit que les options de nettoyage de code sont spécifiques à la solution.

Answer 3

Si le plug-in Microsoft Stylecop for Resharper est installé dans Resharper, allez dans Options de Resharper, Outils, puis StyleCop for Resharper. Vous devriez voir une case à cocher Utiliser les lignes simples pour les en-têtes de déclaration.