Executando verificação de segurança...
5

Em sua defesa e de todos que começam a programar, fazer um code review decente requer uma coisa muito importante, que você saiba o que você quer ler.

Quando a gente abre um repo qualquer no github, buscando olhar o codigo e entender por si só, prepare a frustação, pois mesmo que o codigo esteja muito organizado, que a pessoa que escreveu tenha ano de experiência com determinada linguagem, os motivos por trás daquela implementação podem ser o verdadeiro obstaculos do entendimento.

Eu acho que um bom ponto para começar a ler código alheio é ler codigo das pessoas próximas a tu, perguntar o que ela queriam com determinadas implementações e, por incrível que pareça, dar o seu código pra outras pessoas revisarem e fazerem as mesmas perguntas, "Mas que *%@#$ você fez aqui?" rsrs

Carregando publicação patrocinada...
2

Realmente, as pessoas podem pensar o mesmo do meu código. Irei pensar em práticas para diminui isto, como adicionar mais comentários e etc... Não pensei neste ponto. Além disso irei começar lendo código de projetos menores até me acostumar mais com está prática.

Obrigado pelo o comentário!

1

Olá Araujo! Bem, adicionar mais comentários não torna seu código melhor. O que deve ser feito é melhorar a escrita de código, torná-lo fácil de entender. E isso pode ser feito de algumas formas simples:

  • Nomeando funções, variáveis e classes com nomes autoexplicativos (mesmo que eles se tornem longos);
  • Criar arquivos separados para diferentes funcionalidades do código;
  • Criar funções que realizem apenas uma ação, fazendo o que seu nome realmente diz que ela faz;
  • Procurar sempre a melhor forma para resolver o problema.

Essas são apenas algumas formas de tornar o código melhor.

“O uso adequado de comentários é para compensar nossa falha em nos expressar em código.”
Por Robert C. Martin (autor do livro Clean Code)

Óbvio, as vezes é necessário adicionar um comentário em nosso código. Mas sempre que pensar em comentar algo, pense: "O que eu poderia fazer para tornar esse código mais fácil de entender?". Acredite, sempre há uma forma de melhorar o código, mesmo que o processo seja demorado ou cansativo.


Recomendo a leitura dos livros "O guia do mochileiro Python" e "Clean code".
Até mais!

1

Opa, estou ciente de que uma quantidade exagerada de comentários é realmente, huum, como posso dizer, errado? Bom, posso afirmar que vai de contra a proposta de ajudar.

Entretanto, eu não comento absolutamente nada em código. Então comentários estratégicos, pode ser interessante.

Sobre o padrão, eu já utilizo. Eu sempre tento padronizar nome de funções com o prefixo Handle seguido do que faz, algo como HandlePaste. Nesse sentido, aplico o mesmo em outras partes do código.