Como fazer um bom CODE REVIEW

O sucesso de um projeto de software não depende apenas da capacidade de um código funcionar, mas também de sua clareza, manutenibilidade e da colaboração da equipe. O Code Review, ou revisão de código, é uma prática essencial nesse processo, não como um julgamento final, mas como uma oportunidade de aprendizado e aprimoramento contínuo. Este artigo aborda as melhores práticas para realizar um Code Review eficaz, destacando a importância de ter um checklist, fornecer feedback construtivo, entender o contexto do código, automatizar processos, realizar revisões menores, e promover a colaboração entre os desenvolvedores. Além disso, são apresentados exemplos práticos de como identificar e corrigir problemas comuns no código, como nomes de variáveis pouco descritivos, funções longas e complexas, falta de tratamento de erros, código repetitivo e uso de valores "hardcoded". Implementar essas práticas pode transformar o Code Review de uma tarefa burocrática em uma ferramenta poderosa para elevar a qualidade do software e fortalecer o trabalho em equipe.

A Importância da Clareza no Código

Um dos pilares de um bom desenvolvimento de software é a clareza. O autor cita uma frase de Martin Fowler, uma autoridade em arquitetura de software, que diz: "Qualquer um pode escrever um bom código que o computador entenda. Bons programadores escrevem código que os humanos entendem." Isso ressalta que, embora um código possa funcionar perfeitamente, ele precisa ser legível e compreensível por outros desenvolvedores que possam vir a mantê-lo no futuro. A manutenção e a evolução de um software dependem diretamente da sua capacidade de ser entendido por uma equipe.

Qualquer um pode escrever um bom código que o computador entenda. Bons programadores escrevem código que os humanos entendem.

Checklist para um Code Review Eficaz

Ter um checklist é fundamental para garantir que nenhum aspecto importante seja esquecido durante a revisão. Esse checklist deve incluir pontos cruciais que asseguram a qualidade e a padronização do código. Entre os itens essenciais a serem verificados, destacam-se:

O código segue os padrões da equipe? Cada equipe pode ter suas próprias convenções de código, como o uso de TypeScript, bibliotecas específicas, ou padrões de comentários.
Há testes automatizados cobrindo as alterações? Os testes são cruciais para garantir que as novas implementações não quebrem funcionalidades existentes.
O código está claro e legível? A clareza facilita a compreensão e a manutenção futuras.
Não há código duplicado ou redundante? A repetição de código deve ser evitada para manter a manutenibilidade.
O impacto do desempenho foi avaliado? Mudanças podem afetar a performance da aplicação.
Todas as dependências externas foram gerenciadas corretamente? Gerenciar dependências é vital para a estabilidade do projeto.

Feedback Construtivo e Respeitoso

O feedback no Code Review deve ser sempre claro e respeitoso. O objetivo é ajudar o autor do código a melhorar, e não criticá-lo de forma destrutiva. Em vez de dizer que o código "não presta", o revisor deve ser específico e sugerir melhorias. Por exemplo, apontar uma seção específica e propor uma alternativa, explicando os benefícios da mudança. A comunicação deve ser um diálogo, não um julgamento.

Compreenda o Contexto do Código

Antes de iniciar a revisão, é crucial ler a descrição do Pull Request e entender o problema que o código se propõe a resolver. Sem esse contexto, a revisão pode ser superficial e ineficaz. Conhecer o propósito da alteração permite que o revisor avalie o código de forma mais profunda, identificando se ele realmente atende aos requisitos do problema.

Automatize Onde For Possível

A automação é uma aliada poderosa no Code Review. Ferramentas como linters (ex: ESLint para JavaScript) e testes automatizados podem identificar muitos problemas comuns de forma automática, economizando tempo e esforço dos revisores. A integração contínua (CI) e a entrega contínua (CD) facilitam a automação de muitas verificações.

Revisões Pequenas e Frequentes

Evitar revisões de código muito extensas é uma prática recomendada. Um Pull Request com milhares de linhas de código é difícil de revisar de forma eficaz. É melhor quebrar grandes tarefas em partes menores, resultando em Pull Requests menores e mais focados. Isso torna o processo de revisão mais saudável e permite que os revisores se aprofundem em cada alteração sem se sentirem sobrecarregados.

Colaboração e Processo Contínuo

O Code Review não é um julgamento final, mas um processo colaborativo. Após o feedback, o revisor e o autor devem trabalhar juntos para implementar as mudanças necessárias. Em algumas equipes, reuniões rápidas podem ser organizadas para discutir as alterações e ajudar na implementação. Essa colaboração transforma o Code Review em uma oportunidade de troca de conhecimento e crescimento mútuo da equipe.

Exemplos de Melhorias em Code Review

A seguir, são apresentados exemplos práticos de problemas comuns encontrados em códigos e como o Code Review pode ajudar a corrigi-los:

Nomes de Variáveis e Funções Pouco Descritivos

Um código com variáveis e funções como calque(A, B) dificulta a compreensão do seu propósito. Renomear para algo como calcularOperacaoComplexa(base, fator) torna o código muito mais legível e autoexplicativo, facilitando a manutenção futura.

Funções Longas e Complexas

Funções muito longas, como uma processOrder que realiza cálculos, logs e aplicação de descontos, são difíceis de entender e manter. A solução é refatorar e separar as responsabilidades em funções menores e mais específicas, como calcularTotal(), aplicarDesconto(), entre outras. Isso melhora a clareza e a modularidade do código.

Falta de Tratamento de Erros

Um código que realiza operações como uma requisição fetch API sem tratamento de erros pode lançar exceções inesperadas na tela do usuário. Implementar blocos try-catch é fundamental para tratar esses erros de forma elegante e fornecer feedback adequado ao usuário, melhorando a robustez da aplicação.

Código Repetitivo

A repetição de código, como múltiplos blocos if-else para realizar ações semelhantes, é um sinal de que o código pode ser otimizado. Uma solução é criar estruturas de dados, como objetos, que mapeiam valores e ações, permitindo um código mais conciso e elegante. No exemplo dado, ao invés de vários if para cada cargo, um objeto com chaves junior, pleno e senior pode ser usado, imprimindo a mensagem diretamente.

Uso de Valores "Hardcoded"

Valores fixos (hardcoded) diretamente no código, como Price - Price * 0.15, dificultam a manutenção e a reutilização. É preferível definir esses valores como constantes (constantes) com nomes descritivos, como DISCOUNT_RATE. Isso não só melhora a legibilidade, mas também permite que o valor seja facilmente alterado e reutilizado em outras partes do código.

Takeaways

Revisão Colaborativa e de Aprendizado: O Code Review deve ser visto como uma ferramenta de troca de conhecimentos e crescimento da equipe, não como um julgamento.
Checklist Essencial: A utilização de um checklist garante que todos os aspectos importantes do código, como padrões da equipe, testes e legibilidade, sejam verificados.
Feedback Construtivo e Específico: Fornecer feedback claro, respeitoso e focado em soluções ajuda o autor a melhorar o código, sem ser ofensivo.
Compreensão do Contexto: É crucial entender o problema que o código se propõe a resolver para uma revisão eficaz e profunda.
Automatização de Tarefas: Ferramentas como linters e testes automatizados são fundamentais para identificar problemas comuns de forma eficiente.
Revisões Menores e Frequentes: Dividir grandes mudanças em Pull Requests menores e mais focados torna o processo de revisão mais gerenciável e eficaz.
Melhoria Contínua: Identificar e corrigir problemas como nomes pouco descritivos, funções longas, falta de tratamento de erros, códigos repetitivos e valores hardcoded, eleva a qualidade do código.