virtuablog

Estamos iniciando hoje uma série de postagens curtas com dicas úteis relacionadas a programação e design.

A dica de hoje é: evite utilizar números mágicos nos códigos.

Vou explicar essa dica com um exemplo: estamos escrevendo um programa que lide com a manipulação de dias da semana. Supondo que em várias partes do código seja necessário fazer uma iteração nesses dias, podemos escrever em diversos momentos laços de repetição indo de 1 a 7. Utilizando o número 7 ao longo do código, futuramente poderemos encontrar pelo menos dois grandes problemas:

1. Se outra pessoa precisar fazer manutenção no sistema, talvez ela tenha um certo trabalho para descobrir o porquê de ter sido usado o número 7, e não 10 ou 500. Pode não ficar claro que estamos lidando com dias da semana utilizando apenas o número 7.
2. Se precisarmos fazer com que o sistema lide com os dias do mês, será preciso verificar em todo o código a ocorrência do número 7 e substituir seu valor.

Esses números sem uma explicação bem definida espalhados no código são chamados números mágicos  e sua utilização é desaconselhada. Em vez disso, podemos utilizar constantes ou parâmetros, tornando o código mais semântico e legível.

No exemplo citado, o número 7 poderia ser a constante QUANTIDADE_DIAS, e no código apareceria um laço indo de 1 a QUANTIDADE_DIAS. Além de ficar auto-explicativo, para modificar a quantidade de dias bastaria alterar o valor da constante em uma única linha.