Guanabara.info: Podcast, Tecnologia, iPhone, Notícias, Tutoriais, Vídeo Aulas, Programação

Fala pessoal deixamos os códigos de lado por um momento, e vamos falar sobre as Guidelines, ou diretrizes de programação.

As Guidelines são regras usadas para quando vocês está desenvolvedo algo. A idéia é deixar o código o mais legível possível, e com isso deixar o código com um indice de manutenibilidade alto.

Irei indicar apenas as básicas, relacionadas a nomeclatura de método e propriedades.

PascalCasing e CamelCasing

Os nomes dos metodos e propriedades devem seguir o chamado PascalCasing, ou seja, deve ter  a inicial de cada palavra maiuscula.

Exemplos:

//Métodos

public void GetNumber();

public void GetName();

public void GetCustumerNameById()

public void SetFlag();

//Propriedades

public int Number{get;set;}

public decimal UnitPrice{get;set;}

public string Name{get;set;}

public int NumberOfWheels{get;set;}

Já os parametros e váriaveis locais deve seguir o chamado CamelCasing, ou seja, a primeira letra deve ser minuscula e as iniciais das outras palavras devem ser maiusculas.

Ex:

public string GetNameByLastName(string lastName);

public int GetVehicleType(int numberOfWheels);

public decimal GetUnitPrice(string productName);

Veja o casing dos parametros das funções. O mesmo deve ser aplicado para as varíaveis locais.

Metodos e verbos?

Pois é. Segundo essa guideline TODOS os metodos devem iniciar com verbos. Se você vai adicionar algo, use Add, se vai pegar algo de algum lugar, use Get, se vai atribuir alguma coisa a algo, use Set, e assim vai.

Ex.:

// Pega um numero

public int GetNumber();

// Adiciona um numero

public int AddNumber( int id);

//Encontra um numero em uma coleção(array)

public int FindNumberInCollection(int id);

Existe uma outra guideline que diz: “Todas as propriedades booleanas devem iniciar com Has, Can ou Is”

Ex.:

//Exemplos

public bool IsAlive{get;set;}

private bool CanRead{get;set;}

protected bool HasRows{get;set;}

Bem legível não?

Ah! Quase esqueci, existe uma Guideline que diz ; “Todos os metodos, propriedades, variaveis, enfim todos os nomes devem estar em inglês”.

E essas são apenas algumas das guidelines de nomeclatura e podem ser aplicadas para qualquer linguagem. É impressionante como essas regrinhas simples deixam um código mais legível e fácil de entender.

Se quiserem estudar mais sobre: http://msdn.microsoft.com/en-us/library/ms229042.aspx

E não é apenas para programação que existem, existe Guidelines para Banco de dados, XML e muitas outras linguagens.