Código limpo: escrevendo para humanos e para máquinas

Aprenda princípios para escrever código fácil de ler, entender e manter.

Quando a gente começa a programar, normalmente pensa:
“Funcionou? Então está ótimo.”

Mas no mundo real, tem um detalhe importante:
seu código não é lido só pelo navegador — ele é lido por pessoas (inclusive você no futuro 😄).

Código limpo é código que funciona e é fácil de entender, manter e evoluir.

Por que código limpo importa?

Imagine uma cozinha:

  • ingredientes jogados = difícil cozinhar
  • tudo organizado e etiquetado = trabalho rápido e seguro

Com código é igual. Código limpo ajuda a:

  • encontrar bugs mais rápido
  • adicionar novas funcionalidades sem quebrar tudo
  • trabalhar em equipe com menos confusão
  • economizar tempo no longo prazo

Princípios práticos de código limpo

1) Use nomes claros

Prefira nomes que explicam a intenção.

// Ruim
let x = 10;

// Melhor
let quantidadeDeProdutos = 10;

2) Funções pequenas e com uma responsabilidade

Uma função deve fazer uma coisa bem feita.

// Melhor separar responsabilidades
function calcularTotal(preco, quantidade) {
  return preco * quantidade;
}

function formatarMoeda(valor) {
  return `R$ ${valor.toFixed(2)}`;
}

3) Evite repetição (DRY - Don't Repeat Yourself)

Se você copia o mesmo trecho várias vezes, transforme em função.

function mostrarErro(msg) {
  console.error("Erro:", msg);
}

4) Mantenha padrão de estilo

Escolha um padrão e siga sempre:

  • indentação consistente
  • uso de ponto e vírgula (ou não), mas com consistência
  • aspas simples ou duplas com padrão único
  • organização de blocos e espaços

5) Comentários com propósito

Comentários bons explicam o porquê, não o óbvio.

// Bom: explica a regra de negócio
// Aplicamos 10% de desconto para clientes premium

Evite comentários que repetem o código.

// Ruim: comentário óbvio
// Soma a + b
const total = a + b;

6) Trate erros de forma clara

Não esconda erro. Mostre contexto útil.

try {
  processarPagamento();
} catch (erro) {
  console.error("Falha ao processar pagamento:", erro.message);
}

7) Evite funções gigantes

Se uma função ficou muito longa, quebre em partes menores com nomes descritivos.

8) Prefira const e let (evite var)

  • const para valores que não mudam
  • let para valores que mudam

Isso reduz erros e deixa intenção mais clara.

Ferramentas que ajudam no código limpo

ESLint

“Professor de regras”.
Aponta problemas e más práticas no JavaScript.

Prettier

“Organizador visual”.
Padroniza formatação automaticamente.

Editor com autoformat

Ajuda a manter padrão sem esforço manual toda hora.

Mini exemplo: antes e depois

Antes

function c(a,b){let t=a*b;console.log(t);return t}

Depois

function calcularTotal(preco, quantidade) {
  const total = preco * quantidade;
  console.log("Total calculado:", total);
  return total;
}

Mesmo resultado, muito mais legível.

Resumo da lição

  • Código limpo é escrever pensando em leitura humana e manutenção.
  • Bons nomes, funções pequenas e padrão visual fazem muita diferença.
  • Evitar repetição e tratar erros melhora qualidade.
  • Ferramentas como ESLint e Prettier aceleram boas práticas.
  • Código limpo hoje = menos dor de cabeça amanhã.