As revisões de código são importantes porque melhoram a qualidade do código e tornam a sua base de códigos mais estável. Além disso, ajudam os programadores a construir relações e a trabalhar em conjunto de forma mais eficaz.
Mas rever o código de um colega é mais fácil de dizer do que de fazer. Para não mencionar que executar um processo de revisão pode ser um pesadelo para os líderes de equipa. Por essa razão, explicamos o que procurar numa revisão de código, o processo de revisão de código, e quais são as nove melhores práticas de revisão de código.
Leia ou avance para a secção que mais lhe interessa:
- Bomás Práticas de Revisão de Código
- Peer Code Review Best Practices
- Code Review Best Practices For How to Run a Code Review
- Apply Code Review Best Practices With as Ferramentas Certas
- ▶️ Inicie a sua Análise de Código Estático Experimente Grátis
Code Review Best Practices
Aqui estão as nove melhores práticas de revisão de código:
1. Saber o que procurar numa Revisão de Código
2. Construir e testar – Antes da Revisão
3. Não Rever Código por Mais de 60 Minutos
4. Não verificar mais de 400 Linhas de cada vez
5. Dar Feedback Que Ajuda (Não Dói)
6. Comunicar Objectivos e Expectativas
7. Incluir Todos no Processo de Revisão do Código
8. Promover uma Cultura Positiva
9. Automatizar para poupar tempo
Peer Code Review Best Practices
Damos-lhe a conhecer os segredos mais bem guardados das revisões pelos pares. As revisões pelos pares têm tudo a ver com colaboração e não com competição.
Seguir estas cinco melhores práticas de revisão por pares.
Saber o que procurar numa Revisão de Código
É importante entrar em revisões sabendo o que procurar. Procurar coisas chave, tais como…
Estrutura. Estilo. Lógica. Desempenho. Cobertura de testes. Desenho. Legibilidade (e capacidade de manutenção). Funcionalidade.
P>Pode fazer verificações automáticas (por exemplo, análise estática) para algumas das coisas – por exemplo, estrutura e lógica. Mas outras – por exemplo, concepção e funcionalidade – requerem a avaliação por um revisor humano.
A revisão de código com certas questões em mente pode ajudá-lo a concentrar-se nas coisas certas. Por exemplo, pode avaliar o código para responder:
- Compreendo o que o código faz?
- Faz o código funcionar como eu espero que funcione?
- Faz este código cumprir os requisitos regulamentares?
Ao avaliar o código de forma crítica – com as perguntas em mente – certificar-se-á de que verifica as coisas certas. E reduzirá o tempo quando se trata de testar.
Build and Test – Before Code Review
Na era actual de Integração Contínua (CI), é fundamental construir e testar antes de fazer uma revisão manual. Idealmente, depois de os testes terem sido aprovados, será realizada uma revisão e implantada na linha de código de desenvolvimento.
Esta assegura a estabilidade. E a realização de verificações automáticas primeiro reduzirá os erros e poupará tempo no processo de revisão.
Automação evita a perda de tempo nas revisões.
▶️ Iniciar o seu teste gratuito de análise do código estático >>>
Não rever código por mais de 60 minutos
Nunca rever por mais de 60 minutos de cada vez. O desempenho e a atenção ao detalhe tendem a cair após esse ponto. É melhor realizar revisões frequentemente (e em sessões curtas).
Fazer uma pausa dará ao seu cérebro uma oportunidade de reiniciar. Assim, pode rever novamente com novos olhos.
Dar a si próprio tempo para fazer revisões curtas e frequentes irá ajudá-lo a melhorar a qualidade da base de código.
Check No More Than 400 Lines at a Time
Se tentar rever demasiadas linhas de código ao mesmo tempo, é menos provável que encontre defeitos. Tente manter cada sessão de revisão a 400 linhas ou menos. A definição de um limite de linha de código (LOC) é importante pelas mesmas razões que a definição de um limite de tempo. Assegura-se de que está no seu melhor ao rever o código.
Focalização em menos de 400 linhas torna as suas revisões mais eficazes. E ajuda-o a assegurar uma maior qualidade na base de código.
Dar Feedback Que Ajuda (Não Dói)
Tente ser construtivo no seu feedback, em vez de crítico. Pode fazer isto fazendo perguntas, em vez de fazer declarações. E lembre-se de dar elogios juntamente com o seu feedback construtivo.
Dar feedback pessoalmente (ou mesmo fazer a sua revisão pessoalmente) irá ajudá-lo a comunicar com o tom certo.
p>Seu código terá sempre de ser revisto. E precisará sempre de rever o código dos seus colegas de trabalho. Quando abordar as revisões como um processo de aprendizagem, todos ganham.
📕 Recurso Relacionado: Desafio do programador: As suas revisões de código são eficazes?
Code Review Best Practices For How to Run a Code Review
Executar uma revisão de código – e certificar-se de que tudo foi devidamente revisto – pode ser um enorme desafio.
Seguir estas quatro melhores práticas de como executar uma revisão de código.
Comunicar Objectivos e Expectativas
Você deve ser claro sobre quais são os objectivos da revisão, bem como as expectativas dos revisores. Dar aos seus revisores uma lista de verificação irá assegurar que as revisões são consistentes. Os programadores avaliarão o código um do outro com os mesmos critérios em mente.
Ao comunicar objectivos e expectativas, todos poupam tempo. Os revisores saberão o que procurar – e poderão usar o seu tempo sabiamente no processo de revisão.
Incluir Todos no Processo de Revisão de Código
Não importa quão sénior seja o programador, todos precisam de rever e ser revistos. Afinal de contas, todos têm um melhor desempenho quando sabem que outra pessoa estará a olhar para o seu trabalho.
Quando estiver a executar revisões, é melhor incluir tanto outro engenheiro como o arquitecto de software. Eles detectarão diferentes questões no código, em relação tanto à base de código mais ampla como à concepção global do produto.
Incluindo todos no processo de revisão, melhora a colaboração e as relações entre programadores.
▶️ Iniciar o seu ensaio gratuito de enxame de Helix >>>
Foster a Positive Culture
Fomentar uma cultura positiva em torno de revisões é importante, uma vez que desempenham um papel vital na qualidade do produto. Não importa quem introduziu o erro. O que importa é que o erro foi apanhado antes de entrar no produto. E isso deve ser celebrado.
Ao promover uma cultura positiva, irá ajudar a sua equipa a apreciar (em vez de temer) as críticas.
Automate to Save Time
Existem algumas coisas que os revisores terão de verificar nas revisões manuais. Mas há algumas coisas que podem ser verificadas automaticamente usando as ferramentas certas.
Analizadores de código estático, por exemplo, encontram potenciais problemas no código, verificando-o em relação às regras de codificação. A execução de analisadores estáticos sobre o código minimiza o número de problemas que atingem a fase de revisão pelos pares. A utilização de ferramentas para revisões leves também pode ajudar.
Utilizando ferramentas automatizadas, é possível poupar tempo no processo de revisão por pares. Isto liberta os revisores para se concentrarem nas questões que as ferramentas não conseguem encontrar – como a usabilidade.
📕 Conteúdo relacionado: Como fazer revisões de código
Aplicar as melhores práticas de revisão de código com as ferramentas certas
Se quiser aplicar as melhores práticas de revisão de código, precisará das melhores ferramentas.
A Melhor Revisão de Código Começa com as Ferramentas Perforce
Perforce tem ferramentas para melhorar o seu processo de revisão do princípio ao fim.
Como os Analisadores Estáticos Perforce Melhoram as Revisões de Código desde o Início
Analisadores Estáticos Perforce – Helix QAC para C/C++ e Klocwork para C, C++, C#, e Java – podem ser usados para analisar código e eliminar erros de codificação antes de o código chegar à fase de revisão pelos pares.
Certifique-se de que o seu código está em conformidade com as regras de codificação. E destaca e prioriza questões que precisam de ser corrigidas, para que os programadores possam ser mais eficientes no processo de revisão.
Os revisores podem adicionar as suas anotações ao código fonte – juntamente com as mensagens de diagnóstico do Perforce Static Analyzers. E os programadores recebem notificações quando os Analisadores estáticos encontram problemas relacionados com a sua parte do código.
Como o Helix Swarm Facilita a Colaboração
Helix Swarm é uma ferramenta de revisão de código baseada na web que é incluída com o Helix Core. Pode utilizá-la para escalar as revisões à medida que a sua equipa cresce e melhorar a colaboração durante o processo.
Helix Swarm facilita a execução de revisões, automatizando o processo. As equipas podem utilizar esta ferramenta para monitorizar o progresso e ver quais estão completas – e quais estão ainda em curso.
Os revisores recebem notificações automáticas sobre as suas tarefas e um painel de controlo dos seus itens de acção. Além disso, todos podem facilmente colaborar, tendo conversas directamente no código. Veja por si próprio como o Helix Swarm o ajudará.
▶️ Veja uma demonstração do Helix Swarm
Enforce Code Review Best Practices With Static Analysis
Perforce static code analyzers – Helix QAC and Klocwork – e Helix Swarm integra-se com Jenkins e outros executantes de construção. Assim, pode executar builds e testes antes dos seus ciclos de revisão por pares.
Usar ferramentas de revisão de código Perforce elimina o tempo de espera e ajuda-o a colaborar melhor ao longo de todo o processo. Veja por si próprio como os analisadores estáticos Perforce o ajudarão.
▶️ análise de código estático teste gratuito