Ao escrever código, um dos aspectos mais negligenciados, porém críticos, é a nomenclatura.

Os nomes que escolhemos para variáveis, funções, classes e outras entidades em nosso código podem impactar significativamente a legibilidade, a capacidade de manutenção e a qualidade geral.

O Capítulo 2 do Clean Code investiga a arte e a ciência de escolher nomes significativos, fornecendo um conjunto de diretrizes que podem ajudar os desenvolvedores a escrever códigos que sejam expressivos e compreensíveis.

Nesta postagem do blog, exploraremos as principais conclusões deste capítulo, ilustrando cada conceito com exemplos em JavaScript.

?1. Use nomes que revelam intenções

Os nomes que você escolher devem transmitir claramente a intenção por trás da variável, função ou classe. O leitor deve ser capaz de entender o que o código faz sem precisar de contexto adicional.

// Bad
let d; 

// Good
let daysUntilDeadline;

No primeiro exemplo, d é vago e não fornece contexto. A versão melhorada, daysUntilDeadline, indica claramente o que a variável representa.

?2. Evite a desinformação

Os nomes não devem ser enganosos. Evite usar nomes que possam implicar um significado diferente daquele que o código realmente faz.

// Bad
let accountList = new Map();

// Good
let accountsMap = new Map();

Aqui, accountList pode ser enganoso porque sugere uma lista (que é uma coleção ordenada), enquanto a estrutura de dados real é um mapa. Usar o accountsMap é mais preciso.

?3. Faça distinções significativas

Se você precisar diferenciar variáveis, funções ou classes semelhantes, faça-o de uma forma que torne a distinção clara e significativa.

// Bad
getUserInfo();
getUserData();

// Good
getUserProfile();
getUserSettings();

No primeiro exemplo, getUserInfo e getUserData são muito semelhantes e não transmitem claramente suas diferenças. O segundo exemplo esclarece a distinção nomeando as funções com base no que elas retornam.

?4. Use nomes pronunciáveis

Os nomes devem ser fáceis de ler e pronunciar. Isso torna a discussão do código com outras pessoas mais simples.

// Bad
let genymdhms;

// Good
let generationTimestamp;

genymdhms é um nome não pronunciável que seria difícil de lembrar ou discutir. GenerationTimestamp, no entanto, é claro e fácil de dizer.

?5. Use nomes pesquisáveis

Em bases de código maiores, é importante usar nomes que sejam fáceis de pesquisar. Evite usar nomes com uma única letra ou nomes excessivamente abreviados.

// Bad
let e = document.getElementById('email');

// Good
let emailInputElement = document.getElementById('email');

e não é facilmente pesquisável e não transmite o que representa. emailInputElement é mais descritivo e mais fácil de localizar na base de código.

?6. Evite codificações

Evite incluir tipos, prefixos ou outras codificações em seus nomes. Deixe o próprio nome ser descritivo o suficiente.

// Bad
let phoneString;

// Good
let phoneNumber;

Neste caso, phoneString inclui uma codificação de tipo desnecessária (String). phoneNumber é mais simples e direto.

?7. Os nomes das classes devem ser substantivos, os nomes das funções devem ser verbos

As classes representam objetos ou conceitos, portanto seus nomes devem ser substantivos. As funções, por outro lado, representam ações, portanto seus nomes devem ser verbos.

// Class names (Nouns)
class UserAccount {}
class ShoppingCart {}

// Function names (Verbs)
function calculateTotal() {}
function sendEmail() {}

Essa distinção ajuda a entender a função de cada elemento em seu código.

?8. Evite mapeamento mental

Não force o leitor a traduzir um nome em algo mais significativo. O nome deve ser autoexplicativo.

// Bad
let n = 5; // Number of users

// Good
let userCount = 5;

n exige que o leitor lembre ou deduza que representa o número de usuários, enquanto userCount é imediatamente claro.

Conclusão ⚡

Escolher nomes significativos é mais do que apenas uma questão de estilo – é uma prática fundamental para escrever código limpo e de fácil manutenção.

Seguindo as diretrizes descritas no Capítulo 2 do Clean Code, você pode melhorar a legibilidade do seu código JavaScript e torná-lo mais fácil para outras pessoas (e para você mesmo) entenderem e manterem.

Lembre-se, o objetivo é escrever um código que comunique seu propósito e lógica, reduzindo a carga cognitiva do leitor.

Na próxima vez que você nomear uma variável, função ou classe, considere os princípios de nomenclatura significativa e como eles podem contribuir para um código mais limpo e eficaz.

Boa codificação!