ti-enxame.com

O que fazer se um colega de trabalho estiver editando seu código apenas para alterar a aparência?

O que você deve fazer se um colega de trabalho estiver editando seu código?

Sem o propósito de adicionar funcionalidades ou corrigir bugs, apenas para mudar sua aparência ...

17
Tamara Wijsman

Fale com eles sobre isso. Entre na conversa com a atitude de "Eles não estão fazendo isso para me irritar ou porque têm algum tipo de transtorno obsessivo-compulsivo; estão tentando melhorar meu código".

Porque você pode estar errado. Isso poderia ser uma correção de bug sutil e você simplesmente não percebeu.

Ou pode ser que haja um padrão de codificação que você não conhece e que está violando e que eles estão apenas corrigindo.

Ou pode ser que eles estejam tentando incomodá-lo ou tenham algum tipo de transtorno obsessivo-compulsivo. Se for esse o caso, peça-lhes educadamente que parem e, se isso não funcionar, converse com seu chefe.

Mas você nunca saberá a menos que pergunte.

28
BlairHippo

Não sou tão casado com a aparência do meu código que me incomoda. :) Tento aprender com as mudanças. Meu colega de trabalho ajustou os nomes das variáveis? Escreva um loop mais eficiente? Tornar o código mais legível?

Se não consigo ver como as mudanças melhoraram o que já estava lá, costumo perguntar ao colega de trabalho que fez as mudanças qual foi a motivação por trás delas. É possível que a vantagem não seja óbvia para mim. E se eu estiver certo e eles errados, então talvez eu possa explicar por que escrevi dessa maneira.

Se tudo mais falhar, reverta o check-in. ;)

Edit: Todas as apostas estão canceladas se o desejo de fazer mudanças cosméticas introduzir um bug.

16
Adam Lear

IMO, você e sua equipe devem usar um padrão de codificação de qualquer maneira. Se for esse o caso, a questão se torna 'seu código original está em conformidade com o padrão?' Se 'sim', então seu colega não deve tocar em seu código, a menos que seja para alterá-lo funcionalmente. Se "não", então seu colega tem todo o direito de organizar seu código. Como líder de projeto, faço isso o tempo todo.

Se você não estiver usando um padrão de codificação, todo o argumento do que constitui 'bom código' se torna subjetivo demais. Portanto, por que você deve usar um padrão de codificação :)

9
Neil

Como uma das aquelas pessoas (as pessoas que ocasionalmente reformatam o código de outras pessoas), a principal razão de eu fazer isso é a legibilidade. Algumas pessoas são extremamente desleixadas com sua indentação ou com a mistura de tabulações e espaços.

A principal coisa que tenho o hábito de mudar é reduzir as linhas longas para poder ler tudo sem rolar horizontalmente. Dividirei instruções complexas em instruções separadas ou reformatarei chamadas/declarações de métodos para listar um parâmetro por linha, se nem tudo couber confortavelmente em uma única linha. Também editarei comentários, seja para corrigir erros de inglês ou apenas para tornar as coisas mais claras.

Sim, eu poderia deixar como está, mas prefiro reduzir o esforço mental necessário para ler o código.

O que você deve fazer sobre isso? Em primeiro lugar, considere que talvez essa pessoa esteja melhorando seu código. Além disso, você deve garantir que haja algum consenso em sua equipe sobre como o código deve ser formatado. Se cada pessoa tiver hábitos diferentes, isso tornará todo mundo mais lento. Se eles não estão melhorando seu código e estão indo contra a corrente, você precisa confrontá-los sobre isso. Se isso não funcionar, talvez seja necessário envolver outras pessoas.

8
Dan Dyer

Pergunte por que eles estão fazendo isso; uma explicação válida pode diminuir sua frustração, mas você deve deixá-los saber o quanto isso o incomoda. Quem sabe, talvez eles pensaram que estavam te fazendo um favor e vão parar quando souberem que te ofende. Ou você pode estar lidando com alguém que está realmente sofrendo de uma condição médica.

6
JeffO

Ele/ela tem permissão para isso? As mudanças melhoram o código? Se sim, engula seu orgulho. Se você sentir que a qualidade do código piorou, converse com o colega e pergunte por que eles sentiram a necessidade de alterar seu código sem nenhum benefício óbvio. Se estiver sendo feito por despeito ou porque a pessoa erroneamente sente que é melhor do que você e você não consegue resolver isso com ela, converse com seu chefe.

5
Chinmay Kanchi

IDEs como o Visual Studio têm uma opção chamada Format Document que formatará o código de acordo com as regras que o usuário definiu no IDE. Pode ser que seu colega de trabalho esteja usando isso (automaticamente sem saber ou por aplicação deliberada). Talvez seu IDE use espaços em vez de tabulações, ou vice-versa, e estes estejam sendo aplicados automaticamente sem nem mesmo saber? Mas você precisa falar com eles para descobrir.

A propósito, freqüentemente irei formatar novamente o código de colegas de trabalho se ele obviamente não estiver seguindo algum tipo de esquema de formatação (ou seja, está em todo o lugar). É uma maneira sutil de fazê-los notar. (No entanto, eu não o reformataria se fosse legal, mas não do meu gosto).

5
Dan Diplo

Se ele estiver mudando para atender aos padrões de codificação de sua equipe, você deve seguir os padrões da próxima vez.

Se ele alterar de forma que não siga mais os padrões de codificação de sua equipe, informe-o o que ele está fazendo de errado e peça que altere novamente.

... Sua equipe tem um conjunto de padrões de formatação de código que são usados ​​por todos, certo?

3
Daenyth

Ocasionalmente, reordeno o código escrito por colegas de trabalho confusos (ou corrijo erros de digitação nos comentários). Eles sabem que sou obsessivo na formatação e ordem do código e, portanto, me deixam fazer isso sem reclamar muito. Às vezes, eles também me dão um refrigerante ou biscoito de graça.

Claro que isso é ocasional trabalho, pois quebrou a funcionalidade de "culpa" no SVN.

Essa também é uma maneira muito básica de fazer algum tipo de revisão de código (geralmente leio a maior parte do código comprometido por meus colegas de trabalho nos módulos em que estou trabalhando).

2
Wizard79

Convenções de código é o resposta. Você deve ter um no trabalho. Se não, comece agora (um bom ponto de partida é guia de estilo do google ). Quando existem regras escritas (ou pelo menos comumente conhecidas), a resposta à sua pergunta é trivial.

2
Ilia K.

Eu sinto que você está pensando que é ofensivo fazer isso ...? Por exemplo, eu mesmo consertaria imediatamente este código

int myFunction( ) {

    int i ;
  return  0;

}

tornar-se

int myFunction() {
    int i;
    return 0;
}

então ... devo ser punido por causa da minha ação? Na vida real, tenho toneladas de registros SVN lidos em 'Formatação'. ;-)

1
tia

Use uma ferramenta de verificação de estilo

Comece a usar StyleCop ou similar e aplique as regras de estilo de código e também torne obrigatório para todos os desenvolvedores o seu uso. Todo o código terá a mesma aparência, sem exceção. E reúna-se com especialistas para discutir as regras mais apropriadas para sua organização. Mesmo que as regras padrão sejam muito semelhantes ao próprio código da estrutura .net.

É a maneira mais fácil de fazer isso. Eu me descobri corrigindo o código de outra pessoa em um de meus empregadores anteriores porque esse outro cara estava escrevendo código com quantidades excessivas de linhas vazias e nenhuma regra de recuo. O código era realmente ilegível por um desenvolvedor médio. Se o StyleCop existisse naquela época, muitos de nós ficariam muito felizes.

0
Robert Koritnik

este é um pensamento que vi na internet falando sobre refatoração e talvez explicar por que alguém alteraria seu código para torná-lo melhor:

Por quê?

Existem duas razões principais para refatorar:

  1. Para melhorar o código/design antes de construí-lo no topo: É realmente difícil criar um bom código na primeira tentativa. A primeira tentativa de implementar qualquer projeto inicial nos mostrará que interpretamos mal ou esquecemos alguma lógica.

  2. Para se adaptar às mudanças nos requisitos. Mudanças acontecem no desenvolvimento de software; para responder às mudanças é melhor ter uma boa base de código. Temos duas opções para ambos os cenários, encaminhar o código ou refatorá-lo. Corrigir o código nos levará a um código insustentável e aumentará nosso débito técnico, é sempre melhor refatorar.

Quando?

  1. Quanto antes, melhor e mais fácil.

  2. mais rápido e menos arriscado refatorar sobre um código recentemente refatorado, em vez de esperar para refatorar até que o código esteja quase concluído.

O quê?

  1. Todo o código e todo o design são candidatos à refatoração.

  2. Uma exceção para não refatorar algo pode ser um trecho de código funcional, cuja qualidade é baixa, mas por estar perto do prazo, preferimos manter nosso débito técnico em vez de arriscar a planificação.

Você apenas tem que deixá-lo fazer o seu melhor, se isso for ótimo para ambos e economizar seu tempo no futuro!

felicidades

0
Junior M