Uma dúvida: deve-se encapsular a condicional em função mesmo que ela seja usada apenas uma vez no código?
Em resposta a Clean Code - Conceitos | Exemplos 🎈
1
1
Se isso melhorar a legibilidade, sim.
1
Desculpe insistir, mas se a legibilidade melhora em função do nome da função - isValidInsertion -, não seria o caso de manter a condicional e apenas acrescer um comentário acima dela, do tipo "#checking if insertion is valid"?
Pergunto porque encapsulando a condicional em uma função que é usada uma única vez, não há qualquer relevância para fins de DRY e, na leitura do código, você acaba, nessa parte, tendo que sair para encontrar a função se quiser verificar a condicional.
1
Você está focando apenas no princípio DRY (Don't Repeat Yourself), e realmente não há relevância no DRY ao criar uma função usada apenas uma vez.
Mas pensa que existem outros princípios que são atendidos ao criar essa função.
Se for algo que claramente pode ser reusado futuramente, você está facilitando o trabalho de manutenção do código.
E como eu disse, boa legibilidade é um princípio super relevante.
Só quem leu um código mau escrito por alguém sabe a dor de cabeça e o tempo gasto pra mexer em qualquer coisa nesse código.
E incluir comentários explicando o código quase nunca é uma boa ideia.
Os próprios nomes de variáveis e funções devem ser autoexplicativos sobre o que eles fazem.
E esse é o ponto de criar uma função: o nome dela vai descrever exatamente o que ela faz, e isso vai te economizar uma linha de comentário, e um dev que ler seu código vai te agradecer pela facilidade na compreensão.
1
Ok, entendi seu ponto. Obrigado pela ajuda.
1
Não só outro dev irá te agradecer pela facilidade na compreensão, você mesmo fará isso quando precisar revisitar esse código depois de um tempo, pois por incrível que pareça, as vezes a gente não faz ideia da nossa linha de raciocínio de outrora.