Como nomear variáveis: Guia para código limpo e legível
6 min de leitura
Nomear variáveis é a decisão de design mais frequente que um programador toma. Bons nomes tornam o código autodocumentado; maus nomes forçam os leitores a decifrar sua lógica.
Princípios fundamentais
- Revelar a intenção:
elapsedTimeInDayse nãod - Evitar desinformação: Não chame de
accountListalgo que na verdade é um set - Usar nomes pronunciáveis:
generationTimestampe nãogenymdhms - Usar nomes pesquisáveis:
MAX_STUDENTS_PER_CLASSe não7
Padrões de nomes por tipo
| Tipo | Padrão | Exemplos |
|---|---|---|
| Boolean | is/has/can/should + adjetivo | isActive, hasPermission |
| Contador | substantivo + Count/Total | retryCount, totalItems |
| Coleção | Substantivo no plural | users, selectedItems |
| Função | verbo + substantivo | calculateTotal, fetchUser |
| Event handler | handle/on + evento | handleClick, onSubmit |
Antipadrões
data,info,temp,stuff— vagos demaisa,b,x— aceitáveis apenas em lambdas e fórmulas matemáticasflag— flag de quê? UseisEnabledem vez disso- Notação húngara (
strName,intAge) — obsoleta com IDEs modernos
Formate seus nomes
Use o conversor camelCase para variáveis JavaScript, o conversor snake_case para Python, ou o hub de conversão de case.