Padrão de nome de métodos: boa práticas para um código limpo e profissional

Se você escrever código Java profissional, legível e manutenível, precisa entender a importância dos nomes de métodos. Um bom padrão de nomenclatura não apenas melhora a compreensão do seu código, mas também facilita a colaboração em equipe e reduz erros.

Neste post, vamos abordar todas as diretrizes essenciais para nomear métodos de maneira clara e eficiente. Bora aprender?

O que são métodos?

Antes de falarmos sobre nomes, é importante relembrar o conceito de métodos.

Na programação orientada a objetos, um método é um bloco de código que executa uma tarefa específica. Ele pode receber argumentos, retornar valores e ser chamado quantas vezes for necessário.

Exemplo de um método simples em Java:

Regras essenciais para nomear métodos

Aqui estão as diretrizes fundamentais que você deve seguir ao nomear seus métodos:

Use verbos no infinitivo

Os métodos devem indicar claramente a ação que realizam. Use verbos no infinitivo para representar essa ação.

Exemplos corretos:

Exemplos errados:

Comece com letras minúsculas e use camelCase 

Os nomes de métodos devem iniciar com letra minúscula e seguir o padrão camelCase (primeira palavra minúscula, palavras subsequentes com iniciais maiúsculas). 

Correto:

Errado:

Evite siglas e abreviações ambíguas

Evite nomes curtos e abreviados que não deixem clara a intenção do método. Prefira nomes completos e descritivos.

Correto:

Errado:

Use prefixos padronizados para melhor leitura

Existem prefixos comuns para diferentes tipos de métodos:

Tipo de Método	Prefixo Comum	Exemplo
Método Getter	get	getNome()
Método Setter	set	setIdade(int idade)
Método de Verificação	is / has / can	isAtivo() / hasSaldo() / canLogin()
Ação de Manipulação	add / remove / update	addProduto(), removeItem(), updateCliente()

Seguir esses padrões tornam seu código mais fácil de entender e manter.

Evite prefixos desnecessários

Não faça nomes desnecessariamente longos ou repetitivos.

Errado:

Correto:

Exemplos de métodos bem nomeados

Aqui está um exemplo completo de uma classe que segue boas práticas na nomeação dos métodos:

Aqui fica fácil entender o que cada método faz apenas pelo nome, sem precisar analisar o código dentro deles!

Seguir um padrão de nomeação para métodos é essencial para manter um código limpo, organizado e profissional. Usar verbos no inifinitivo, camelCase, prefixos padronizados e evitar siglas ajuda a criar um código mais legível e de fácil manutenção.

Se você gostou desse post, compartilhe com outros desenvolvedores e comente abaixo qual outra boa prática você sempre segue ao programar!