Desenvolvimento - Visual Basic .NET

Padrões de nomenclaturas – Guia de consulta rápida

Para garantir a qualidade de qualquer sistema temos um ponto muito importante a definir em nosso projeto, independente de ser um projeto desenvolvido por uma ou mais pessoas, este ponto é a padronização...

por Alexandre Tarifa



Para garantir a qualidade de qualquer sistema temos um ponto muito importante a definir em nosso projeto, independente de ser um projeto desenvolvido por uma ou mais pessoas, este ponto é a padronização. A forma mais fácil de nosso código estar bem escrito, de forma fácil de entender onde todos da equipe possam saber tudo que acontece no sistema é padronizando o máximo possível do trabalho realizado. O padrão é algo que deve ser definido pela equipe de desenvolvimento antes do início do projeto. Após o padrão definido e o projeto ser iniciado, ele jamais pode ser alterado ou discutido, todos devem seguir o padrão. Estarei mostrando uma padronização que defini. Não sei se é a melhor ou a pior, só sei que se for bem seguida, qualquer projeto fica fácil de ser entendido. Retirei um pouco de sites, um pouco de livros e montei este padrão. Cada equipe de projeto deve se reunir antes do início do projeto e montar o seu padrão onde todos devem opinar e votar nos pontos mais críticos.

Padrão de nomenclatura arquivos

Padrão de Sub´s e funções

Subs

Funções

Variáveis

Objetos

Banco de Dados

Controles

Procedures, Views e Functions

Nomenclatura (ex. Mailing)

Nomenclatura (ex. Banco de Dados Geral)

Parâmetros de Procedures

Idêntico ao campo da tabela inclusive o tipo e o tamanho
Ex. Campo - cliCodigo char (10)
Declare @cliCodigo as char(10)

Caso não seja campo de tabela deve-se seguir o padrão de variáveis.

Tabela

ex. Cadastro de Clientes
tblCliente
Obs. Deve-se evitar comer palavas. Exemplo tblCliInternacional

Campo

ex. Razão Social no Cadastro de Clientes

Tabelas com nomes compostos
Ex. Endereço na tabela tblClienteEndereco

Obs. Campos Padrões

Data: Dt
Quantidade: Qtd

Data (ex. data de cadastro)

Código (ex. Código do cliente)

Comentários

Banco de Dados

Sistemas

Obs: agradeço aos meus companheiros da Deloitte (Thiago, Pretel, Ícaro, Marcão, Cris e André) pela ajuda na criação deste padrão!!!

Alexandre Tarifa
alexandre@codificando.net

Alexandre Tarifa

Alexandre Tarifa - Ministra palestras e treinamentos, MVP (Most Valuable Professional), MCAD (Microsoft Certified Application Developer) e MCT (Microsoft Certified Trainer). Bacharel pela UMESP e pós-graduando pela Universidade Federal de São Carlos em Ciência da Computação. Analista de Sistemas e Líder do grupo de usuários Codificando.net São Paulo (sp.codificando.net). Escreve artigos para a revista MSDN Magazine e para os sites Linha de Código, MSDN Brasil e Enterpriseguys.
Visite o blog do autor: http://weblogs.pontonetpt.com/alexandretarifa/.