Code Review Visual Studio 2012

O Code Review tem o objetivo de validar o código desenvolvido por outro membro da equipe dessa forma fazendo que as equipes consigam um feedback sobre o código fonte da aplicação mais rápido evitando que seja enviado para produção alguns bugs mais básicos.

Porque devo fazer Code Review?

É muito comum que quando os desenvolvedores trabalham por muito tempo em cima de um mesmo código ou projeto ele fique “cego” para pequenos erros que possam estar em sua codificação, por esse motivo uma boa prática é enviar esse código para outro membro da equipe para que possa ser feita uma validação do mesmo.

Quando trabalhamos com Code Review ganhamos alguns benefícios, entre eles:

  • Qualidade e padrão de codificação
  • Localizar Bugs que passaram despercebidos pelo desenvolvedor
  • Possíveis falhas de segurança e estabilidade do sistema
  • Verificar se o código escrito é de fácil entendimento para outros desenvolvedores
  • Aprender com outros desenvolvedores da equipe

Como o fazer um Code Review?

Abaixo vamos realizar um pequeno exemplo de Code Review usando o TFS 2012 e o Visual Studio 2012.

Primeiramente esse exemplo será baseado na classe abaixo:

Depois de criada essa classe vamos requisitar que outro desenvolvedor faça o Code Review desse código, para isso na janela do Team Explorer clique em Request Code Review

Nessa nova janela, temos que preencher quem serão os responsáveis por essa revisão, nesse caso estamos selecionando o usuário Cameron Skinner e depois clicar no botão Submit Request

Nesse momento será enviado um e-mail para o usuário que selecionamos para realizar a revisão de código conforme a imagem abaixo

Quando o usuário Cameron abrir o seu Visual Studio e ir em Team Explorer -> My Work teremos uma nova atividade de code review requisitada pelo Brian conforme a imagem abaixo

Para abrir essa requisição, basta dar um duplo clique sobre o item e será aberta a janela de CodeReview contendo o work item relacionado a aquela alteração, o comentário adicionado pelo Brian, e os arquivos que devem ser feito o Code Review

O próximo passo é aceitar ou rejeitar esse Code Review, para isso clique no link Accept ou Decline, nesse exemplo vamos clicar em Accept conforme a imagem abaixo

Nesse momento também será enviado um e-mail para quem requisitou o Code Review informando se foi aceitado ou rejeitado

Agora vamos revisar a classe calculadora, clique sobre a classe para que seja aberta no Visual Studio, nesse momento vamos ter uma visão da classe antes da alteração e depois da alteração realizada conforme abaixo

Veja que é uma classe bem simples, porém no método Dividir temos um erro que pode ocorrer na execução, que é o tratamento de divisão por zero. Então vamos adicionar um comentário no método para que ele possa ser alterado, selecione o método Dividir e clique com o botão direito e selecione a opção Add Comment conforme a imagem abaixo:

Adicione o comentário e clique em Save

Para enviar o code review novamente para quem requisitou, nesse caso o Brian, clique em Send & Finish e selecione a opção With Comments.

Agora quando o Brian entrar na janela Team Explorer -> My Work verá que tem uma resposta para seu code review conforme a imagem abaixo

Para abrir, basta dar um duplo clique sobre o Code Review e veremos os detalhes e comentários que o Cameron adicionou

Agora basta realizar a codificação solicitada, e enviar um novo Code Review, dessa forma teremos o cenário abaixo:

Agora que o código foi revisado podemos finalizar o Code Review, para isso clique em Send & Finish e selecione a opção Looks Good

E para finalizar o Code Review, clique em Close Review e selecione a opção Complete

Conclusão

Lembre-se, esteja sempre aberto a receber criticas sobre seu código, muitas vezes os desenvolvedores defendem seus códigos com unhas e dentes mas o que para você parece ser fácil entendimento, para outros pode ser complexo.

Outro item muito importante é não veja quem está fazendo um code review do seu código não é seu inimigo e sim seu aliado, para que seu código possa melhorar. Então deixe seu orgulho de lado e escute o que os outros membros da equipe pensam sobre seu código!

Deixe seu comentário, opinião, critica

Aquele abraço!

Sobre Leandro Prado

Leandro Silveira Prado é Premier Field Engineer na Microsoft especializado em Application Lifecycle Management.