Óculos sob uma tela de código, ilustrando Boas práticas de Code Review no blog DB1 Code Journey
Desenvolvimento

Boas práticas para Code Review

Óculos sob uma tela de código, ilustrando Boas práticas de Code Review no blog DB1 Code Journey
Thiago Vidal
Thiago Vidal
01 de junho de 2020
Óculos sob uma tela de código, ilustrando Boas práticas de Code Review no blog DB1 Code Journey

O problema de não ter o processo de code review 

Acontece em várias empresas e vários projetos: há um desenvolvedor que detém um conhecimento de certa parte de código de um projeto, onde somente ele mexe e não existe nenhum tipo de documentação, que só roda na máquina dele e ninguém mais sabe como funciona.  

Digamos que esse desenvolvedor fique doente, saia de férias ou até mesmo busque outra oportunidade em outras empresas. Como ficaria esse código? 

Em determinadas situações, o código é reescrito e fica tudo bem, mas em outras a empresa pode até perder um cliente pois ninguém consegue dar manutenção. E é aqui que o processo de code review entra. 

O que é Code Review? 

“Code Review é uma examinação sistemática de código-fonte computacional. Tem como intenção encontrar erros que passaram desapercebidos no desenvolvimento de software, melhorando a qualidade do software. Essas revisões são feitas de várias formas, como pair-programming, análises informais e até inspeções formais.” – Wikipédia, tradução livre por Moacir Moda.

Code Review é fácil de se fazer, mas muitas vezes é deixado de lado, negligenciado devido ao tempo gasto para realizar ou urgência de entregas. Mas se for pensar assim, nunca irá entender a mentalidade por trás do conceito que se trata de organização, prevenção, otimização de tempo e o próprio desenvolvimento coletivo da equipe. 

Com essa cultura bem definida, a equipe se apropria do código do projeto e todos conseguiriam dar manutenção, todos têm que praticar essa cultura. 

Mas e , como desenvolver essa cultura? 

Podemos fazer como Pair programming, ou seja, sentar-se ao lado do colega e começar a discutir e programar. Não tem muito segredo, mas tem que ter um bom senso devido ao investimento de tempo na atividade, fazer isso somente para resolver problemas estruturais pensando no desenvolvimento futuro. 

Temos também Pull Request, quando se usa github como ferramenta de gerenciamento de repositórios git, quando você um push da sua branch local para fazer o merge para sua branch principal você pode clicar no botão de New Pull Request e você poderá descrever o que foi feito e solicitar a revisão da sua equipe. Após aprovação já é realizado o merge automaticamente para a branch principal. 

Mas qual é a intenção de realizar um Code Review? 

Abrir o código do colega e encher de comentários sobre todas as não boas práticas? Não é bem assim! 

A intenção do bom code review é revisar e aprimorar a resolução de um problema, isso vai fazer o nível técnico seu e da equipe evoluir muito.  

O recomendado é analisar os seguintes itens durante a revisão:   

– Se adequa à arquitetura existente? 

Segue os padrões adotados pela equipe no projeto? 

O código está no lugar certo? 

Reutilização de código 

A complexidade está muito alta? 

Os nomes que foram utilizados em variáveis, campos, parâmetros, classes e métodos refletem o que ele realmente representa? 

Somente lendo o código é possível entender o que ele faz? 

O código contém algum Bug, uma comparação errada?  

Cabe a quem analisa o código levantar os detalhes acima esquecidos durante a implementação, além disso adicionar comentários sobre o possível bug de implementação encontrado na funcionalidade ou alteração. 

Cuidado ao comentar o Pull Requet do colega. 

Existem muitos perfis de profissionais, então cuidado durante os comentários. Sem usar sarcasmo ou algum tipo de repreensão. Não há necessidade de usar comentários que provem que você é mais experiente que outras pessoas, seja mais maleável durante os comentários para que se a pessoa for novata que ele aprenda de verdade com aquele code review. 

Não faça nada às pressas. 

Mesmo tendo pressão externa para uma entrega, não deixe de fazer o code review, pois isso pode virar uma bola de neve mais pra frente e prejudicar o projeto de alguma forma. O código que ficou mal-escrito pode atrapalhar alguém no futuro ao ler esse código e não compreender absolutamente nada do que está sendo feito ali. 

Boas práticas no code review 

– Seja claro na comunicação. 

– Ser educado, faça críticas construtivas. A intenção é a resolução do problema. 

– Não tente reinventar a roda. 

Sobre o autor 

Thiago Moço Vidal é formado em Tecnologia em Processamento de Dados pela FEMA, com mais de 10 anos atuando como desenvolvedor/analista de software. Atualmente finalizando uma especialização em Gestão de Projetos e integrante da equipe de IT Services da DB1 Group, atua como desenvolvedor C#.Net e se aperfeiçoando em novas tecnologias de desenvolvimento. 

Referências: 

https://imasters.com.br/desenvolvimento/code-review-comunicacao-amigavel-e-cultura/?trace=1519021197&source=single 

https://moacirmoda.com/code-review-e-qualidade-de-software/ 

https://pt.slideshare.net/RodrigodeSouzaCastro/o-que-devo-procurar-em-um-code-review-81769974 

https://thiagobrito.com.br/a-import%C3%A2ncia-do-code-review-89e7c359f7a2 

 

 


Escrito por

Thiago Vidal
Thiago Vidal
Thiago Moço Vidal é formado em Tecnologia em Processamento de Dados pela FEMA, com mais de 10 anos atuando como desenvolvedor/analista de software. Atualmente finalizando uma especialização em Gestão de Projetos e integrante da equipe de IT Services da DB1 Group, atua como desenvolvedor C#, .Net e se aperfeiçoando em novas tecnologias de desenvolvimento.

Inscreva-se e receba nossa newsletter!

Estamos sempre gerando conteúdos inéditos para compartilhar conhecimento com você, além das últimas notícias de tecnologia.