Dicas.NET - Regras importantes para nomenclatura

Regras importantes para nomenclatura

É importante observarmos e até mesmo documentarmos algumas regrinhas de nomenclatura no visual studio .net

Quando criamos um projeto, o nome do projeto vira o root NameSpace do projeto. Assim sendo todas as classes dentro do projeto são referenciadas com projeto.classe

Quanto criamos um item dentro do projeto, em geral o nome deste item vira um nome de classe. Isso nos leva a 1ª regra:

Regra 1: Não criar um item dentro do projeto que tenha o mesmo nome do projeto. Se isso for feito o VS não saberá quando estamos nos referindo ao rootnamespace ou a classe interna e começará a gerar erros no código oculto.

O fato de que os itens adicionados em projeto geram classes também nos leva para a regra Nº 2. Esta 2ª regra pode parecer básica, mas na verdade é muito fácil que ao adicionar um item o desenvolvedor esqueça que está adicionando uma classe e pense apenas a nível de arquivo, gerando a confusão.

Regra 2: Os nomes de itens adicionados não podem conflitar com classes do framework .net, pois tal conflito de nomenclatura dificultará a produção de código, dificultando o uso de imports.

A relação entre arquivos e classes nos leva para a regra 3:

Regra 3: Ao mudar o nome de um arquivo devemos estar atentos para o fato de que não estamos mudando o nome da classe que o arquivo contém.

A regra Nº 3 possui alguns casos especiais, mais complexos, que nos levam para a regra 4 e 5:

Regra 4: Ao trocar o nome de uma classe no codebehind de um arquivo .ASPX não esqueça de trocar o atributo inherits na tag @Page da página .ASPX

Regra 5: O nome de um dataSet é utilizado dentro de sua estrutura de schema XML e se tentarmos trocar a estrutura de schema não é corrigida. Ou entramos na estrutura de schema e corrigimos manualmente ou o melhor pode ser eliminar o dataSet e recria-lo.