Clean Code: 5 boas práticas essenciais para escrever código sustentável

Muitos programadores acreditam que sua tarefa acaba quando a máquina finalmente compila o código e executa a função desejada sem erros. Isso está longe de ser verdade. Escrevemos código primeiramente para que outros humanos entendam; a máquina entendê-lo é apenas um detalhe secundário.

O Clean Code (Código Limpo) não é sobre frescura estética. O tempo de leitura de código comparado ao tempo de escrita costuma ser de 10 para 1. Se o código for difícil de ler, o desenvolvimento em equipe torna-se lento e as chances de bugs se multiplicam.

1. Nomenclatura baseada na Intenção

Pare de dar nomes curtos com medo de gastar letras. Variáveis não devem ser misteriosas. Um nome deve responder imediatamente: por que a variável existe, o que ela faz e como ela é usada.

2. Funções devem fazer Apenas Uma Coisa

Essa é a famosa regra da Responsabilidade Única (Single Responsibility Principle). Uma função que busca dados do banco, formata uma tabela em HTML, valida os campos e envia um e-mail é um desastre esperando para acontecer.

O ideal é quebrar essa rotina monstruosa em funções modulares. Se um bug ocorrer no envio de e-mail, você saberá exatamente em qual bloco de código mexer sem afetar o banco de dados.

3. Evite aninhamentos profundos (Ifs aninhados)

O clássico "Código Hadouken", que vai sendo empurrado para a direita em uma escada de condições If/Else, é exaustivo para ler. Utilize a técnica de Return Early (Guard Clauses). Valide as falhas imediatamente no início da função e as retorne, deixando o "caminho feliz" para o final sem precisar aninhar no nível 15 de indentação.

4. Comentários são pedidos de desculpas

Se você precisa colocar um comentário para explicar o que um bloco complexo de código está fazendo, isso é sinal de que você deveria ter refatorado o bloco para algo mais claro. O código em si deve contar a história. Comentários ficam defasados e mentem facilmente com o passar do tempo, enquanto o código executa apenas a verdade do momento.

5. Evite "Números Mágicos"

Números soltos no meio do código sem contexto criam confusão instantânea. Em vez de usar if (status == 2), extraia isso para uma constante descritiva const STATUS_APROVADO = 2; e compare contra ela.