Nomenclaturas em .NET

Olá pessoal, neste artigo irei falar sobre as nomenclaturas e as regras de boas práticas para escrever os códigos em C#.

É muito importante seguir uma padronização ao escrever códigos, pois muitas vezes dois ou mais desenvolvedores trabalham no mesmo código e isso facilita e muito a leitura e o desenvolvimento posterior.

A maioria dos fontes de exemplo da Microsoft, ou de seus funcionários estão no mesmo padrão, então, é de suma importância nós desenvolvermos no mesmo padrão.

Como padrão para todas as nomenclaturas em C#, tem que ser bem descritiveis, até mesmo com frases, para saber exatemente para que ela serve.

Classes

As classes devem começar com letra maiúscula e para cada palavra, a primeira letra também deve ser maiúscula.

 public class Empresa { }

 public class HistoricoDeCompra { }

 public class ItemDaVenda { }

Interfaces

As interfaces devem começar com a letra ‘I’ maiúscula e para cada palavra, a primeira letra também deve ser maiúscula.

 public class IPedidoService { }

 public class IHistoricoDaCompra { }

 public class IItemDoPedido { }

Campos

Os campos para utilização interna devem começar com letra minúscula, e para cada palavra, a primeira letra deve ser maiúscula. Já, se forem utilizados por uma propriedade, deve se iniciar com underline “_”, e para cada palavra, a primeira letra deve ser maiúscula.

 private string cliente;

 private DateTime dataDeNascimento;

 private int _codigoDoProduto;

Propriedades

As propriedades devem começar com letra maiúscula e para cada palavra, a primeira letra também deve ser maiúscula.

 public string Nome { get; set; }

 public DateTime DataDeNascimento { get; set; }

 public int CodigoDoProduto { get; set; }

Métodos

Os métodos devem começar com letra maiúscula e para cada palavra, a primeira letra também deve ser maiúscula.

 public string GetNome()

 public bool Verificar()

 public void Executar()

Parâmetros
Os parâmetros devem começar com letra minúscula e para cada palavra, a primeira letra deve ser maiúscula.

 public void SetNome(string nome)

 public bool Verificar(int codigoDoCliente)

 public void Executar(DateTime dataDaExecucao)

Variáveis
As variáveis devem começar com letra minúscula e para cada palavra, a primeira letra deve ser maiúscula.

 string nome;

 var i = 0;

 int quantidadeDeProdutos;

Fontes de consulta e Referências:

Pensando .NET – artigo de referência à este post.

.NET com Esmeraldino – artigo de consulta completo que lista os padrões para todas as linguagens do .NET.

Abraços.

Até o próximo artigo pessoal