Escreva para ser revisado

Melhor prática 4 - o código deve ser escrito para ser revisado

Ao escrever seu código de software, lembre-se de que alguém irá revisar seu código e você terá que enfrentar críticas sobre um ou mais dos seguintes pontos, mas não se limitando a:

  • Codificação ruim
  • Não segue o padrão
  • Não tendo o desempenho em mente
  • História, recuo, comentários não são apropriados.
  • A legibilidade é fraca
  • Os arquivos abertos não são fechados
  • A memória alocada não foi liberada
  • Muitas variáveis ​​globais.
  • Muita codificação rígida.
  • Tratamento de erros deficiente.
  • Sem modularidade.
  • Código repetido.

Mantenha todos os pontos mencionados acima em sua mente enquanto codifica e interrompa-os antes que eles acessem seu código-fonte. Quando terminar de codificar, faça uma autoavaliação pelo menos uma vez. Tenho certeza de que uma autoavaliação o ajudaria a remover 90% dos problemas sozinho.

Assim que terminar sua codificação e auto-revisão, solicite a seu colega uma revisão de código. Eu recomendo fortemente aceitar comentários de revisão com prazer e devo ser grato a seus revisores de código sobre os comentários. Ao mesmo tempo, nunca é bom criticar qualquer código-fonte escrito por outra pessoa. Se você nunca fez isso, tente uma vez e verifique a expressão do codificador.

Aceite críticas, mas não critique

Um código-fonte mal escrito ensina a escrever um bom código-fonte, desde que você o considere positivamente e aprenda uma lição com ele.

Seu objetivo deve ser parar os bugs em primeiro lugar e criar um código LIVRE DE BUGS. Pense como um testador, de modo que você deve ter um desafio para os testadores.