Nomeando variáveis, classes e métodos

Quem nunca pegou um código para dar manuntenção e perdeu horas apenas para entende-lo ou as vezes até desistiu e acabou fazendo tudo novamente a tentar entender o antigo? Se você programa a algum tempo com certeza isso já lhe acontenceu.

Penssando nesse problema em que me deparei várias vezes, resolvi escrever alguns artigos com dicas de como escrever um bom código.

Nesse primeiro artigo irei sugerir boas práticas para nomear suas variáveis, classes e métodos. Vamos ao trabalho.

Não use letras para nome de variáveis.

   1: int a;

   2: DateTime d;

   3: String s;

Use nomes que revelem seu propósito

   1: int idade;

   2: DateTime nascimento;

   3: string nome;

Não ha necessidade de especificar o tipo da variável no seu nome.

   1: String stringNome;

   2: List listPessoas;

Essa era uma prática antiga que ajudava aos desenvolvedores a saberem o tipo da variável. Hoje não temos mais esse problema com as novas IDEs, que apenas com o mouse em cima da variável já nos informa seu tipo.

Não use nomes que possam confundir  por seu formato.

   1: int l; //letra L minúscula que pode ser confundida com 1 (um)

   2: int O; //letra O que pode ser confundida com 0 (zero)

 

Não use números sequenciais para suas variáveis, eles não são expressivos.

   1: string pessoa1;

   2: string pessoa2;

   3: string pessoa3;

 

Não use nomes não pronunciáveis.

   1: Datetime dataamd; //data, ano, mês, dia

Evite usar abreviações.

   1: int detDim;

 

Use nomes expressivos.

   1: int determinanteDimensional;

 

Não adicione informações desnecessárias.

Se o seu contexto é pessoa não ha razão para suas variáveis serem declaradas da forma abaixo.

   1: string nomePessoa;

   2: int idadePessoa;

   3: int pesoPessoa;

 

Use nomes passíveis de busca.

Agora algumas dicas para nomear classes:

Não deve ser um verbo.

Devem conter substantivos.

   1: public class Cliente { ... }

   2:  

   3: public class Conta { ... }

   4:  

 

Agora algumas dicas para nomear métodos:

Devem ter verbos.

   1: private void ReceberPagamento() {};

   2:  

   3: private void Excluir() {};

   4:  

   5: private void Salvar() {};

   6:  

Não use nomes engraçados. (também se aplica a variáveis e classes)

   1: public bool CairFora() {}; //para significar Sair();

Bom é isso, espero que possa lhes ajudar a escrever um melhor código,

em breve escreverei outros artigos com mais dicas.

See you.