Por que revisamos o código

Feb 17 2023
Como revisar o código sem desperdiçar o tempo de todos (parte 1)
Como desenvolvedor iOS, analisei milhares de linhas de código de meus colegas. Como a programação, revisar o código faz você se sentir inteligente ou totalmente estúpido.
Crédito do ícone: GitHub, Volvo Cars

Como desenvolvedor iOS, analisei milhares de linhas de código de meus colegas. Como a programação, revisar o código faz você se sentir inteligente ou totalmente estúpido.

Isso ocorre devido aos principais problemas com as revisões de código:
1. As pessoas realmente não sabem por que revisam o código.
2. As pessoas não analisam as coisas certas.
3. As Pull Requests não podem ser revisadas.

Neste artigo, nos concentramos no motivo pelo qual revisamos o código.

Algumas das razões

Fiz essa pergunta a muitos candidatos em entrevistas, obtendo uma gama muito diversificada de respostas. Muitas vezes, as pessoas revisam o código porque é uma boa prática conhecida, sem se aprofundar no motivo pelo qual é realmente uma boa prática.

Para ver por que revisamos o código, a melhor pergunta que podemos nos fazer é: por que desejaríamos que outra pessoa revisasse nosso código?

Aqui estão algumas das razões:

  • Queremos saber se o código pode ser entendido por alguém que não seja nós.
  • Queremos identificar outras áreas confusas, como nomes de variáveis, classes, métodos, etc.
  • Queremos outro par de olhos que possa nos lembrar se esquecemos alguma coisa (ou seja, mudamos o nome de uma variável no último minuto e alguma falha de design ficou aparente).
  • Queremos aprender com nossos colegas se uma abordagem melhor pode ser adotada para resolver o mesmo problema.
  • Cometemos um erro de digitação e chamamos uma variável `tmoato` em vez de `tomato`, então agora uma classe que costumava contar vegetais parece estar invocando deuses maias.

Se você olhar atentamente para a lista, poderá perceber que há apenas dois itens na lista que realmente precisam de mais pessoas.

Essa é uma particularidade das revisões de código. Na maioria dos casos, quando você cria uma Pull Request, você é a pessoa mais indicada para revisá-la. Você notará erros de digitação e praticamente qualquer coisa que tenha esquecido.

Os desenvolvedores não estão sozinhos nisso. Os escritores fazem o mesmo.

Stephen King é conhecido por passar por três rascunhos antes de enviar um romance para a editora. Do primeiro ao segundo rascunho, ele nem pede feedback, mas revisa ele mesmo.

Isso soa familiar?

De uma chance.

Da próxima vez que você criar um Pull Request, revise-o primeiro por conta própria. Em seguida, peça a alguém para revisá-lo. Eles provavelmente destacarão comentários valiosos para você, como áreas difíceis de entender ou decisões ruins ao projetar APIs.

Entendendo porque

Ao revisar seu próprio código, você pode identificar facilmente a maioria dos erros de digitação, testes ausentes ou erros básicos. No entanto, se você acredita que a palavra “chefe” está escrita como “chef”, ainda falará sobre cozinheiros quando quiser falar sobre líderes. Outro par de olhos pode ajudá-lo a encontrar os últimos detalhes que polirão seu código.

Dito isso, se, ao revisar o código, você comentar apenas as áreas que alguém poderia revisar por conta própria, provavelmente não entendeu.

As revisões de código tratam de obter feedback, clareza e garantir que o que você entende possa ser entendido por outras pessoas.

Qual é o próximo?

Agora que você sabe por que revisamos o código, precisamos entender melhor o que precisa ser revisado e como isso deve ser feito. Eu dei algumas das respostas neste artigo, mas vou me aprofundar enquanto forneço exemplos específicos.

Você pode seguir a Volvo Cars Engineering se quiser receber atualizações sobre quando o próximo artigo estiver disponível. Ao fazer isso, você também ajuda muitos engenheiros a compartilhar ideias e aprendizados.