Boas práticas para programação

Vamos falar sobre boas práticas para programação. Este é um tema muito importante pra quem está começando na área e com certeza vai fazer toda a diferença para quem vai manter seu código. E não esqueça que este alguém pode ser você mesmo!

Para dar nome aos seus métodos, atributos, variáveis ou objetos utilize sempre nomes que façam sentido e que sejam autoexplicativos. Evite abreviar a não ser que seja extremamente necessário.

Propriedades (Atributos) e Métodos

Propriedades e métodos devem seguir a notação PascalCasing. Isto significa que a primeira letra de cada palavra deve ser maiúscula.

Para métodos utilize verbos para facilitar o entendimento do mesmo (GetName, SetValue, AddName, …).

Ex:

//Métodos
public void SetName();
public List GetAll();
public string GetLastName();

// Propriedades
public int Idade { get; set; }
public string Nome { get; set; }
public decimal PrecoVenda { get; set; }

Parâmetros e Variáveis

Parâmetros e variáveis devem segir a notação CamelCasing. Isto significa que, após a primeira palavra, cada palavra deve iniciar em letra maiúscula.

private int contador; // Variável privada, do tipo inteiro, chamada “contador”

private string nomeCliente; // Variável privada, do tipo string, chamada “nomeCliente”

public string GetById(int id);  // Método publico, retorna inteiro, chamado “GetById”

public string GetNameByCnpj(string cnpj);  // Método publico, retorna string, chamado “GetNameByCnpj”

Booleanos (Bool)

Para declaração de booleanos, é recomendável utilizar Has (Tem), Can (Pode) ou Is (É).

Ex:

// Propriedade
public bool IsValidName { get; set; };

//Vaviável
private bool hasLastName;

//Vaviável
private bool canRead;

Componentes

Para nomes de componentes (TextBox, Button, Form, etc.) utilize as três primeiras letrar minusculas indicando o tipo de componente e em seguida o nome do componente com cada letrar inicial de uma palavra em maiúsculo.

Ex.:

txtName // TextBox Name
txtLastName // TextBox Last Name
btnSave // Button Save
lblStatus // Label Status
Se você programa em .Net pode utilizar esta tabela para nome de componentes:  https://jcecilio.wordpress.com/2009/12/11/boas-praticas-em-programacao/

Anúncios

Deixe um comentário

Preencha os seus dados abaixo ou clique em um ícone para log in:

Logotipo do WordPress.com

Você está comentando utilizando sua conta WordPress.com. Sair / Alterar )

Imagem do Twitter

Você está comentando utilizando sua conta Twitter. Sair / Alterar )

Foto do Facebook

Você está comentando utilizando sua conta Facebook. Sair / Alterar )

Foto do Google+

Você está comentando utilizando sua conta Google+. Sair / Alterar )

Conectando a %s

%d blogueiros gostam disto: