Como posso comparar 2 arquivos e ignorar quaisquer alterações nos comentários?

Question

Eu estou usando C # e VB.NET.

Muitas vezes (todos os dias ...) adicionar comentários aos arquivos de origem existentes. Quando eu o check-in esses arquivos, eu gostaria de ter a minha ferramenta de mesclagem para ignorar as alterações feitas aos comentários -. Eu só quero ter certeza que eu não alterar o código

Eu uso WinMerge e Team Foundation Server Control (sim, sem chance: Subversion não era uma opção quando aceitei este trabalho: o). Ambos podem ignorar os espaços em branco, mas não pode ignorar os comentários. Resultado:.. Eu tenho que olhar cuidadosamente para todas as mudanças que eu fiz para cada arquivo antes de verificar-los e isso é muito complicado

(Bem, já que a maioria dos meus colegas de trabalho não fazer comentário em tudo - hey, eles usam namespace / classe / métodos / Propriedade / Tipo / nomes muito longos constantes que contam tudo, caras - é muito de trabalho.)

Todas as sugestões?

Todo o melhor, Sylvain.

Answer 1

BeyondCompare tem um filtro para ignorar mudanças "sem importância" e comentários pertencem a essa categoria por padrão.

Answer 2

Compare ++ tem uma opção "Ignorar comentário mudanças" e "Ignorar alterações formatados puros", que deve honrar o seu pedido.

Answer 3

Você disse que você usou WinMerge - bem ele tem a capacidade de filtrar comentários

. No entanto, só funciona para comentários que estão em uma linha separada, assim, por exemplo:

int i; // comment

será detectado como diferente

int i;

Answer 4

Parece que você está usando comentando como uma ferramenta para entender o código como você trabalhar com ele. Isso é uma idéia interessante, o equivalente a destacar um livro ou tomar notas. Mas você precisa ter certeza de que você tira todos esses comentários transitórios antes de trabalhar com os outros.

Antes de comparar ou promover, executar seus arquivos de origem através de um programa de filtro que retira o comentário. Este poderia ser um script de uma linha perl.

Para facilitar, use um padrão distinto por seus comentários não-permanentes, para torná-los mais fáceis de filtrar (e para distinguir entre esses comentários transitórios, e comentários que você realmente quer sair na fonte). Por exemplo. se você estivesse escrevendo em C ++, sempre comentam usando

 //Sylvain: this is my comment here.

ou algum outro padrão que é ainda mais fácil de pesquisar por.

Answer 5

Se o conteúdo dos comentários não são algo que lhe interessa, e não importa, porque não excluí-los?

Se o código bem documentado que é legível e compreensível é parte do que você cria, porque não rever alterações a essa meta-dados?

Answer 6

Como adicionar comentário ao seu código é cheiro que seu código é difícil de ler, o código deve ser auto descrever, como alguém disse que, bom código é como boa piada, ele não precisa de ser explicada. É melhor mudar o seu nome de variável, seção colocar de seu código em uma sub-rotina. Re factoring é melhor do que comentar. Mesmo que você encontrar uma ferramenta para resolver você comentando problema, não resolve o problema real que é fazer você código fácil de entender.