Guia de Convenções de Nomenclatura para Desenvolvedores

A forma como você nomeia variáveis, funções e arquivos pode parecer questão de gosto, mas na verdade é uma regra que molda a produtividade da sua equipe e a legibilidade do seu código.

Por que as convenções de nomenclatura importam

O código é lido muito mais vezes do que é escrito. Uma convenção de nomenclatura consistente ajuda os outros, e o seu eu do futuro, a entender o código rapidamente.

Quando as regras são uniformes, apenas o nome já indica se algo é uma variável, uma constante ou uma classe, reduzindo buscas desnecessárias.

Os principais formatos em resumo

• camelCase — primeira palavra em minúscula, primeira letra das palavras seguintes em maiúscula (myVariableName)
• PascalCase — primeira letra de todas as palavras em maiúscula (MyClassName)
• snake_case — tudo em minúscula, palavras unidas por sublinhados (my_variable_name)
• CONSTANT_CASE — tudo em maiúscula com sublinhados, geralmente para constantes (MAX_COUNT)
• kebab-case — tudo em minúscula com hifens, geralmente para URLs e CSS (my-class-name)

Convenções por linguagem e contexto

Muitas linguagens recomendam suas próprias convenções. Python prefere snake_case para variáveis e funções, JavaScript e Java usam camelCase, e a maioria das linguagens usa PascalCase para nomes de classes.

As constantes costumam ser escritas em CONSTANT_CASE independentemente da linguagem, e o kebab-case é praticamente o padrão para caminhos de URL e classes CSS.

A consistência importa mais do que a regra

Nenhum formato único é absolutamente correto. O que mais importa é seguir de forma consistente a regra que seu projeto ou equipe combinou.

Ao entrar em uma base de código existente, prefira as convenções dela em vez do gosto pessoal. Se precisar renomear muitos identificadores de uma só vez, um conversor de capitalização ajuda.