Comment comparer 2 fichiers et ignorer les modifications apportées aux commentaires?

Question

J'utilise C # et VB.NET.

J'ajoute souvent (tous les jours ...) des commentaires aux fichiers sources existants. Lors de l'enregistrement de ces fichiers, j'aimerais que mon outil de fusion ignore les modifications apportées aux commentaires. Je veux simplement m'assurer que je n'ai pas modifié le code.

J'utilise WinMerge et Team Foundation Control Server (oui, aucune chance. Subversion n'était pas une option lorsque j'ai accepté ce travail: o). Les deux peuvent ignorer les espaces mais ne peuvent pas ignorer les commentaires. Résultat: je dois examiner attentivement tous les changements que j'ai apportés à chaque fichier avant de les archiver. Et c'est assez lourd.

(Comme la plupart de mes collègues ne commentent pas du tout - ils utilisent des noms d'espace / de classe / de méthodes / de propriété / de type / de constante assez longs pour tout dire, les gars! de travail.)

Des suggestions?

Tout le meilleur, Sylvain.

Answer 1

BeyondCompare a un filtre pour ignorer "sans importance". les modifications et les commentaires appartiennent par défaut à cette catégorie.

Answer 2

Comparer ++ a une option " Ignorer les modifications apportées aux commentaires " et " Ignorer les modifications formatées pures " qui devrait honorer votre demande.

Answer 3

Vous avez dit que vous utilisiez WinMerge - il permet de filtrer les commentaires.

Cependant, cela ne fonctionne que pour les commentaires qui sont sur une ligne séparée, par exemple:

int i; // comment

sera détecté comme différent de

int i;

Answer 4

Il semble que vous utilisiez les commentaires pour comprendre le code au fur et à mesure que vous le manipulez. C'est une idée intéressante, l'équivalent de mettre en valeur un livre ou de prendre des notes. Mais vous devez vous assurer de supprimer tous ces commentaires passagers avant de travailler avec d'autres personnes.

Avant de comparer ou de promouvoir, exécutez vos fichiers source via un programme de filtrage qui supprime le commentaire. Cela pourrait être un script Perl à une ligne.

Pour faciliter la tâche, utilisez un modèle distinct pour vos commentaires non permanents afin de faciliter leur filtrage (et de faire la distinction entre ces commentaires transitoires et les commentaires que vous voulez vraiment laisser dans la source). Par exemple. si vous écrivez en C ++, commentez toujours avec

 //Sylvain: this is my comment here.

ou un autre motif encore plus facile à utiliser pour grep.

Answer 5

Si le contenu des commentaires ne vous intéresse pas et n'a pas d'importance, pourquoi ne pas les supprimer?

Si un code bien documenté, lisible et compréhensible, fait partie de ce que vous créez, pourquoi ne pas consulter les modifications apportées à ces métadonnées?

Answer 6

Ajouter un commentaire à votre code, c'est sentir que votre code est difficile à lire. Le code doit être auto-descriptif. Comme quelqu'un l'a déjà dit, un bon code est comme une bonne blague, il n'a pas besoin d'être expliqué. Il est préférable de changer le nom de votre variable, mettez une section de votre code dans un sous-programme. Re factoring vaut mieux que commenter. Même si vous trouvez un outil pour résoudre votre problème de commentaire, cela ne résout pas le vrai problème qui est de vous rendre le code facile à comprendre.