2009-06-05 5 views
5

J'ai un code que je maintiens qui a beaucoup de commentaires générés par machine et de régions générées par machine. (Ou créé par un développeur particulier induit en erreur)Comment supprimer les commentaires robo et #region de C#?

Ce sont des commentaires répétitifs exclusivement les extensions de métadonnées de la méthode et de l'espace de noms tubé pascals:

#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 

Y at-il une prise ou caractéristique de ReSharper pour décaper les commentaires et tags #region en vrac?

Répondre

4

Pourquoi ne pas utiliser la regex trouver & substituons dans Visual Studio?

Pour commentaires slash triple:

 ///.* 

Pour les tags de la région:

 [#]region.* 
    [#]endregion 
+0

Fonctionne parfaitement, merci! – MatthewMartin

1

Ces pièces étaient probablement la main typée:

La mise en œuvre d'une barre de méthode publique foo, retour un vide

et

Un paramètre de chaîne valeur nommée entrée

Si cela est dans un projet de bibliothèque de classe, je ne me débarrasser des commentaires xml - ils sont ce qui va apparaître dans l'IntelliSense invites pour ces éléments. Les supprimer pourrait rendre les autres développeurs très en colère contre vous; pour tout le texte ici n'est pas très bon, les invites par défaut sont cryptiques et même pire.

+0

Je sais, je les ai tapés à la main. Je ne vais pas publier de code source réel sur SO. Je suis le seul développeur. Intellisense fournit déjà des méta-données sur les méthodes non commentées. – MatthewMartin

+0

D'accord en général, mais dans ce contexte, je ne pense pas que les commentaires XML ajoutent beaucoup. Il devrait vraiment en dire plus sur ce qu'il fait. –

1

Je dirais que de les remplacer par quelque chose de plus sensible est beaucoup mieux que les dépouiller dehors. Aussi banal soit-il, n'avoir aucun commentaire est toujours pire (à moins que les commentaires ne soient bien sûr incorrects?) :-)

Cela dit, je crois this does what you're looking for.

Pour les tags de la région, vous pouvez essayer d'adapter cette application ou à l'aide regex VS rechercher/remplacer.

1

Je vote que vous allez et les corriger que vous tombez sur eux. J'ai dû faire la même chose ici ... chaque fois que je vais dans une classe qui a de mauvais commentaires (dans mon cas: aucun). Je commente les méthodes/propriétés que je travaille avec eux. Après 3 semaines, j'ai correctement commenté la moitié du code et j'ai développé une meilleure compréhension de l'ensemble du projet.

Questions connexes