Prática De Code Review E Qualidade De Software
Sempre que falamos de Qualidade de Software, logo pensamos em um conjunto de práticas que visa uma entrega de software contendo características como eficiência, corretude e que tenha padrões que facilite manutenções. Uma prática utilizada para garantir essas características é o Code Review.
O code review é uma análise minuciosa do código de uma aplicação, software ou uma solução, onde seu objetivo não é somente encontrar erros, mas também a falta de padrão, nomes incorretos de variáveis e possíveis melhorias na lógica do desenvolvimento. Nesse texto traremos informações que podem auxiliar nessa prática, uma delas são:
- Seja educado: quando seu colega pede a você que revise seu código, não deixe de fazê-lo, não negligencie o seu colega pois se ele pediu para você revisar é porque ele confiou em você algo que é importante. Caso esteja com os prazos apertados, o diálogo é a melhor escolha, estipule um tempo que você tirará para realizar essa revisão;
- Pessoas não estão sendo avaliadas: Isso é tão importante para os revisores, quanto para quem está submetendo. O feedback que o código recebe durante o Code Review não torna o desenvolvedor que escreveu o código bom ou ruim.
- Faça um breve check list: com o checklist você consegue ter uma linha de raciocínio para a prática bem como uma consistência. Alguns exemplos são:
- O código está compreensível?
- Existe algum código redundante ou duplicado?
- O código está seguindo o padrão estrutural?
- As possíveis exceções estão sendo tratadas?
- Os identificadores das variáveis e métodos estão coerentes?
- O código está suficientemente documentado?
- Os requisitos foram atendidos?
Seguindo esses breves pontos o code review traz diversas vantagens, como:
- Compartilhar conhecimento sobre o código;
- Encontrar possíveis bugs e vulnerabilidades;
- Propor diferentes abordagens para um mesmo problema;
- Aumenta a colaboração;
- Ajuda a padronizar o código fonte da aplicação, uma vez que regras de implementação são definidas, com o processo de code review, estas regras podem ser verificadas e sinalizadas caso exista algo fora do padrão.
Para quem quer aprofundar no Code Review, deixo três referências de livros que podem trazer diversos insumos:
- Código Limpo (Clean Code) — Robert Cecil Martin
- O Codificador Limpo — Robert Cecil Martin
- Jornada Ágil de Qualidade — Antonio Muniz, Bárbara Cabral, Rodolfo Colares, Carol Vilas Boas