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: elapsedTimeInDays e não d
  • Evitar desinformação: Não chame de accountList algo que na verdade é um set
  • Usar nomes pronunciáveis: generationTimestamp e não genymdhms
  • Usar nomes pesquisáveis: MAX_STUDENTS_PER_CLASS e não 7

Padrões de nomes por tipo

TipoPadrãoExemplos
Booleanis/has/can/should + adjetivoisActive, hasPermission
Contadorsubstantivo + Count/TotalretryCount, totalItems
ColeçãoSubstantivo no pluralusers, selectedItems
Funçãoverbo + substantivocalculateTotal, fetchUser
Event handlerhandle/on + eventohandleClick, onSubmit

Antipadrões

  • data, info, temp, stuff — vagos demais
  • a, b, x — aceitáveis apenas em lambdas e fórmulas matemáticas
  • flag — flag de quê? Use isEnabled em 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.