Na programação, a importância de nomear funções e variáveis ​​não pode ser exagerada. As funções nomeadas corretamente podem melhorar muito a legibilidade do código, tornando mais fácil para você e para outras pessoas entender e manter o código. Nesta postagem de blog, compartilharemos algumas dicas e truques para nomear funções e fornecer exemplos para ajudá-lo a escrever um código limpo, legível e expressivo. Os exemplos serão em JavaScript, mas essas sugestões podem ser aplicadas a qualquer linguagem de programação.

Dica 1: Use o idioma inglês

O inglês é o idioma dominante na programação, por isso é uma boa ideia usar o inglês ao nomear suas funções e variáveis. Isso tornará seu código mais coeso e acessível a outras pessoas.

//  Bad
const listaDeNombres = ['Ana', 'Carlos', 'Elena'];

// ✅ Good
const nameList = ['Ana', 'Carlos', 'Elena'];

Escolha uma convenção de nomenclatura e cumpra-a. Isso pode ser camelCase, snake_case, PascalCase ou outra convenção. Seja consistente com a convenção escolhida em todo o código.

//  Bad
const item_count = 10;
const fetchItems = () => {};

// ✅ Good
const itemCount = 10;
const fetchItems = () => {};

Os nomes das funções devem ser curtos, intuitivos e descritivos:

• Curto: Fácil de digitar e lembrar.
• Intuitivo: Lê naturalmente e próximo ao discurso comum.
• Descritivo: Reflete o propósito ou funcionalidade da função.

//  Bad
const updCnt = (count) => count + 1;

// ✅ Good
const incrementCount = (count) => count + 1;

//  Bad
const onBtnClk = () => {};

// ✅ Good
const onButtonClick = () => {};

Os nomes das funções não devem repetir o contexto em que são definidos. Remova o contexto de um nome se ele não diminuir a legibilidade.

class User {
  //  Bad
  getUserFullName() { ... }

// ✅ Good
  getFullName() { ... }
}

Os nomes das funções devem refletir o resultado ou saída esperado.

//  Bad
const hasDiscount = price < 100;
return <Button discount={!hasDiscount} />;

// ✅ Good
const noDiscount = price >= 100;
return <Button discount={!noDiscount} />;

Um padrão útil a seguir ao nomear funções é o padrão A/HC/LC:

• Ação (A): Verbo que descreve o que a função faz.
• Alto contexto (HC): domínio primário ou assunto da função.
• Baixo contexto (LC): Informação adicional ou domínio secundário.

// Examples
fetchUserPosts(); // Action: fetch, High context: User, Low context: Posts
handleButtonClick(); // Action: handle, High context: Button, Low context: Click
shouldDisplayMessage(); // Action: should, High context: Display, Low context: Message

//  Bad
const items = 'Apple';
const item = ['Apple', 'Banana', 'Orange'];

// ✅ Good
const item = 'Apple';
const items = ['Apple', 'Banana', 'Orange'];

Embora o uso de emojis em exemplos de código possa torná-los mais atraentes e divertidos, tenha cuidado ao usá-los demais. Às vezes, os emojis podem dificultar a leitura do código, especialmente para aqueles que não estão familiarizados com seus significados. Use-os com moderação e somente quando aumentarem a clareza.

//  Bad
const  = 'Apple';
const  = 'Banana';

// ✅ Good (with a few emojis)
const fruits = ['', '', ''];

Nomear corretamente funções e variáveis ​​é crucial para escrever um código limpo, legível e de fácil manutenção. Seguindo as dicas e truques compartilhados nesta postagem do blog, você pode melhorar a qualidade geral do seu código e torná-lo mais acessível a outras pessoas.

Para recapitular, aqui estão as principais conclusões:

1. Use o idioma inglês para nomear funções e variáveis.
2. Seja consistente com a convenção de nomenclatura escolhida.
3. Mantenha os nomes curtos, intuitivos e descritivos (SID).
4. Evite contrações nos nomes das funções.
5. Não duplique o contexto nos nomes das funções.
6. Reflita o resultado esperado em nomes de funções.
7. Use o padrão A/HC/LC para nomear as funções.
8. Use o singular e o plural adequadamente.
9. Use emojis criteriosamente e com moderação.