Código limpo — ou Clean Code — é mais do que uma técnica: é uma filosofia. Em vez de apenas fazer o código “funcionar”, a ideia é escrever algo que seja fácil de entender, manter e evoluir com o tempo. Para quem trabalha com JavaScript — uma das linguagens mais populares e versáteis do mundo — aplicar os princípios de Clean Code pode fazer toda a diferença em projetos reais, sejam pequenos scripts ou aplicações complexas com dezenas de colaboradores.
Neste guia, vamos abordar as principais boas práticas de Clean Code voltadas ao JavaScript, com exemplos práticos e comparações entre “código sujo” e “código limpo”. Ideal para desenvolvedores que desejam elevar a qualidade do que escrevem e tornar seu trabalho mais legível, performático e sustentável.
Nomeie variáveis de forma descritiva
Evite nomes genéricos como x, data, temp, foo. Um bom nome de variável deve revelar o propósito daquilo que ela representa.
❌ Exemplo ruim:
const d = new Date();
✅ Exemplo limpo:
const currentDate = new Date();
Dica: use nomes no idioma do projeto. Em projetos internacionais, evite misturar inglês com português.
Funções devem fazer apenas uma coisa
Uma das regras mais importantes do Clean Code é: cada função deve ter uma única responsabilidade clara. Funções que fazem muitas coisas são difíceis de testar, entender e reaproveitar.
❌ Exemplo ruim:
function processUser(user) {
saveToDatabase(user);
sendWelcomeEmail(user.email);
updateUserStats(user);
}
✅ Exemplo limpo:
function saveUser(user) {
saveToDatabase(user);
sendWelcomeEmail(user.email);
updateUserStats(user);
}
Ou ainda, separar responsabilidades:
function registerUser(user) {
saveToDatabase(user);
notifyUser(user);
updateStats(user);
}
Evite comentários desnecessários
Se você sente que precisa de um comentário para explicar o que seu código faz, talvez o problema esteja no próprio código. Comentários devem explicar o porquê, e não o como.
❌ Comentário desnecessário:
// Soma o total de itens
const total = items.length;
✅ Código autoexplicativo:
const totalItemsInCart = items.length;
Quando usar comentários? Apenas quando houver lógica complexa, regras de negócio obscuras ou decisões técnicas que precisam ser documentadas.
Reduza dependências externas dentro das funções
Funções que dependem de variáveis externas são difíceis de testar e manter. Prefira passar tudo o que ela precisa como parâmetro.
❌ Exemplo com dependência externa:
let taxRate = 0.1;
function calculateTotal(price) {
return price + (price * taxRate);
}
✅ Melhor abordagem:
function calculateTotal(price, taxRate) {
return price + (price * taxRate);
}
Use estrutura consistente (e padronize com linters)
Linhas quebradas aleatoriamente, chaves fora do lugar e indentação irregular tornam o código confuso. Use ferramentas como Prettier e ESLint para automatizar a formatação e padronização.
Ferramentas úteis:
- ESLint: análise de código estática
- Prettier: formatação automática
- EditorConfig: padronização entre editores
Prefira const e let ao invés de var
O uso de var já é considerado uma má prática no JavaScript moderno, pois introduz escopo funcional ao invés de escopo de bloco, o que pode causar comportamentos inesperados.
✅ Melhor prática:
const PI = 3.14;
let counter = 0;
Simplifique condições e evite aninhamentos
Evite lógica condicional muito complexa. Prefira simplificar ou isolar em funções menores.
❌ Exemplo complexo:
if (user && user.isActive && user.permissions.includes('ADMIN')) {
// ...
}
✅ Código limpo:
function isAdmin(user) {
return user?.isActive && user.permissions.includes('ADMIN');
}
if (isAdmin(user)) {
// ...
}
Evite “magic numbers” e valores hardcoded
Números e strings soltos no meio do código tornam a manutenção difícil. Prefira criar constantes com nomes significativos.
❌ Exemplo ruim:
setTimeout(doSomething, 86400000);
✅ Exemplo limpo:
const ONE_DAY_IN_MS = 24 * 60 * 60 * 1000;
setTimeout(doSomething, ONE_DAY_IN_MS);
Escreva testes (mesmo que básicos)
Código limpo também é código testado. Mesmo que o projeto não use TDD, é essencial escrever ao menos testes unitários para funções críticas.
Ferramentas recomendadas:
- Jest
- Vitest
- Mocha + Chai
FAQ — Dúvidas frequentes sobre Clean Code
O que é Clean Code?
Clean Code é um conjunto de princípios que visa escrever código legível, compreensível e fácil de manter.
Preciso aplicar Clean Code desde o início?
Sim, quanto antes melhor. Refatorar projetos grandes é mais difícil do que começar certo.
Existe uma “receita” de Clean Code?
Não, mas há boas práticas e recomendações amplamente adotadas por desenvolvedores experientes.
Posso usar Clean Code com frameworks como React ou Vue?
Com certeza. Clean Code é uma filosofia que se aplica a qualquer tecnologia.
