5 votes

Comment supprimer les robots-commentaires et les #region en C# ?

J'ai un code que je maintiens et qui comporte une bonne quantité de commentaires et de régions générés par la machine. (ou créé par un développeur particulièrement trompé)

Il s'agit de commentaires reprenant exclusivement les métadonnées de la méthode et les expansions spatiales des noms à casse pascale :

#region methods
/// <summary>
/// Implementation of a public method foo bar, returning a void
/// </summary>
/// <param name="value">A string parameter named value input</param>
public void fooBar(string valueInput)
{

}
#endregion

Existe-t-il un plug-in ou une fonctionnalité de Resharper permettant de supprimer les commentaires et les balises #region en masse ?

4voto

Gavin Miller Points 21752

Pourquoi ne pas utiliser la fonction regex find & replace dans Visual Studio ?

Pour les commentaires à triple barre oblique :

    ///.\*

Pour les étiquettes de région :

    \[#\]region.\*
    \[#\]endregion

1voto

Joel Coehoorn Points 190579

Ces parties ont probablement été tapées à la main :

Implémentation d'une méthode publique foo bar, retournant un void.

y

Un paramètre de type chaîne de caractères nommé entrée de la valeur

Si c'est dans un projet de bibliothèque de classe, je ne me débarrasserais pas des commentaires xml - ils sont ce qui apparaîtra dans les invites intellisense pour ces éléments. Les supprimer pourrait rendre les autres développeurs très furieux contre vous ; pour tout le texte ici n'est pas très bon, les invites par défaut sont cryptiques et encore pire.

1voto

Matthew Brindley Points 5240

Je dirais que les remplacer par quelque chose de plus raisonnable est bien mieux que de les enlever. Aussi banals qu'ils puissent être, l'absence de commentaires est toujours pire (sauf si les commentaires sont incorrects, bien sûr ? Dans ce cas, l'absence de commentaires est certainement mieux) :-)

Cela dit, je crois cela fait ce que vous recherchez .

Pour les balises de région, vous pouvez essayer d'adapter cette application ou d'utiliser la recherche/remplacement par regex de VS.

1voto

SnOrfus Points 6457

Je vote pour que vous y alliez et que vous les répariez au fur et à mesure que vous les rencontrez. J'ai dû faire la même chose ici... chaque fois que j'entre dans une classe qui a de mauvais commentaires (dans mon cas : aucun). Je commente les méthodes/propriétés au fur et à mesure que je travaille avec elles. Après 3 semaines, j'ai commenté correctement environ la moitié du code et j'ai développé une meilleure compréhension de l'ensemble du projet.

Prograide.com

Prograide est une communauté de développeurs qui cherche à élargir la connaissance de la programmation au-delà de l'anglais.
Pour cela nous avons les plus grands doutes résolus en français et vous pouvez aussi poser vos propres questions ou résoudre celles des autres.

Powered by:

X