Criando Código de Qualidade: O Poder das Convenções de Nomenclatura

Gizelly Silva
2 min readAug 15, 2023

--

Convenções de nomenclatura

Se você é desenvolvedor, sabe como é importante escrever código que seja não apenas funcional, mas também legível e compreensível. Uma das maneiras mais eficazes de atingir esse objetivo é seguir as convenções de nomenclatura. Essas regras e práticas estabelecidas tornam seu código mais consistente e facilitam a colaboração com outros desenvolvedores. Neste artigo, vou te apresentar algumas das principais convenções de nomenclatura e como você pode aplicá-las no seu código.

Camel Case e Pascal Case: Um Mundo de Letras

Uma das convenções mais comuns é o Camel Case e o Pascal Case. No Camel Case, as palavras são escritas juntas e a primeira letra de cada palavra subsequente é maiúscula. Já no Pascal Case, a primeira letra também é maiúscula. Isso é particularmente útil quando estamos nomeando variáveis e funções.

Exemplos:

  • Camel Case:
    userImageProfile, getUserByEmail, userService
  • Pascal Case:
    UserImageProfile, GetUserByEmail, UserService

Snake Case e Kebab Case: Separando as Palavras

Outra abordagem é usar o Snake Case e o Kebab Case, em que as palavras são separadas por underscores ou hífens, respectivamente. O Snake Case é mais comum em linguagens como Python, enquanto o Kebab Case é frequentemente usado em URLs e nomes de diretórios e arquivos.

Exemplos:

  • Snake Case:
    user_image_profile, get_user_by_email, set_user_phone
  • Kebab Case:
    user-by-email, user-list, user-list-component

Convenções da Linguagem de Programação

Lembre-se de que diferentes linguagens de programação podem ter suas próprias convenções de nomenclatura. É essencial seguir essas convenções específicas da linguagem para tornar o código mais familiar para a comunidade.

Exemplo Prático

Vamos dar uma olhada em um exemplo de código que incorpora essas convenções:

class GreetingsWorld:
def __init__(self, your_name):
self.your_name = your_name

def say_hello(self):
print("Hello, " + self.your_name)


greeting = GreetingsWorld("Gizelly")
greeting.say_hello() # output: "Hello, Gizelly"

Conclusão

Dominar as convenções de nomenclatura é um passo fundamental para escrever código limpo e compreensível. Ao aderir a essas práticas, você não apenas facilita a colaboração com outros desenvolvedores, mas também torna seu código mais profissional e de alta qualidade.

Lembre-se, a consistência é a chave. Escolha uma convenção siga em todo o código. Com nomes descritivos que revelem a finalidade das variáveis, funções ou classes. Evite abreviações obscuras que possam confundir outros desenvolvedores. Com isso você estará no caminho certo para se tornar um desenvolvedor de alto nível!

Fim 😗🖖🏻

Com isso, encerro por aqui e espero que esse artigo tenha contribuído para o seu entendimento das principais convenções de nomenclatura. Mantenha esses conceitos em mente ao escreve seu próximo código e aproveite os benefícios de um desenvolvimento mais suave e colaborativo.

— Você pode me seguir no LinkedIn e no Github também. 💖

--

--

Gizelly Silva

Desenvolvedora Frontend com mais de 7 anos de experiência, apaixonada por criar interfaces web intuitivas e cativantes que encantam os usuários.