quarta-feira, 1 de outubro de 2008

Nomeando Classes, Estruturas, Interfaces, Métodos e Membros.

- Uma regra geral válida para esses identificadores é utilizar nomes de substantivos. Se não for possível utilizar esta regra, tem algo de errado e que precisa ser reformulado.  

- Utilize nomes simples e fáceis de serem compreendidos em tipos que serão utilizados com mais freqüência.   

- Se for possível, termine o nome do identificador com o nome de sua classe pai. Ex. ArgumentOutOfRangeException, é um tipo de Exception.   

- Interfaces devem possuir a letra “I” como prefixo. Ex. IComponent.   

- Para uma classe que é uma implementação padrão de uma interface, diferencie o nome da classe apenas retirando o prefixo “I”. Ex. class Component : IComponent   

- Para enumerações (Enums) não utilize o sufixo “Enum”. Ex. enum ColorEnum {...}   

- Para métodos, utilize nomes de verbos ou frases com verbos.   

- Uma propriedade deve ser nomeada com um substantivo ou um adjetivo.   

- Não utilize “Get” para propriedades.   

- Para propriedades cujo retorno é booleano, utilize afirmações no nome. Ex. EstáAtivo ao invés de NãoEstáAtivo.     

Aqui termina esta parte de “Naming Guidelines”. Como já foi dito, o nome dado aos seus identificadores pode fazer muita diferença e ajuda a evitar muitas dores de cabeça, além de deixar o código mais limpo e legível.

Obrigado!
Denis Yomura

Nenhum comentário: