Técnicas para desenvolver aplicações VB - Padronização.

Neste artigo vamos abordar técnicas de como desenvolver um aplicação Visual Basic usando regras de padronização com a finalidade de gerenciar a complexidade do código , organizando e controlando o seu trabalho de modo a aumentar a produtividade . Enfim por ordem na casa...

1- Formulários

Para manter um visual padrão e consistente permitindo um interface amigável e objetiva com o usuário final a aparência dos formulários do seu projeto é importantíssima:

1-) Defina um conjunto de botões padrões e os disponha sempre que possível num mesmo local no formulário.

2-) Defina um conjunto de formulários modelos e utilize-os em seu projeto.

Para fazer isto basta você salvar o seu formulário no diretório Template subdiretório Forms. No meu caso o caminho é dado a seguir ( no seu pode ser diferente, dependendo de como instalou o VB )

C:\Program Files\Microsoft Visual Studio\Vb98\Template\Forms

Para inserir o formulário modelo nos seus projetos basta usar  a opção Project| Add Form.

3-) Ao dar nome a controles procure usar uma notação padrão. Abaixo temos uma sugestão:

4-) Quando possível procure utilizar um arrays(vetores) para controles ao invés de nomeá-los separadamente. Assim prefira usar Text1(0).text , Text1(1).text, Text1(2).text, ... ao invés de text1.text , text2.text , text3.text.... Com isto você tem as seguintes vantagens:

Obs: Para criar um arrays de controles , insira o primeiro controle e depois copie(Ctrl+C) e cole (Ctrl+V) o controle no formulário. Você vai receber uma mensagem como a abaixo, responda Sim . Para criar outros controles repita a operação.

You already Have a control Named 'Text1' . Do you want to create  a Control Array ?

1. Quando você usa um array  para nomear controles o VB tem que criar somente um dos controles do array, isto além de aumentar o desempenho faz com que o limite de controles permitidos em um formulário seja maior.
2. Você terá somente uma procedure para cada Evento do controle ao invés de uma procedure para cada controle ; com isto você evitara duplicidade de código
3. Percorrer um controle array é mais fácil ; você pode usar um loop For Each/Next para percorrê-los ou definir suas propriedades

5-) Ao criar menus e sub-menus use o prefixo mnu e o nome abreviado do menu e a seguir o nome da opção do menu ou utilize um array de controles para isto. Exemplo:

Com isto todo o código necessário para gerenciar as opções estará contido em uma procedure.

2- Módulos

Os módulos geralmente contém os códigos dos procedimentos e funções usadas na sua aplicação VB. Eles incluem formulários ,  módulos de classes ,  módulos padrão etc... Uma parte tão importante do seu projeto merece uma atenção especial. 

Para começar dê um nome sugestivo e claro para o seu módulo  e utilize uma descrição que resuma em poucas palavras o objetivo de cada bloco de código.

Cada módulo possui um nome lógico usado dentro da sua aplicação e um nome físico de arquivo. Para facilitar as coisas procure usar um mesmo nome lógico e físico. Você pode usar os prefixos abaixo:

Exemplos:  frmclientes   ,   mfuncoes  , cfornecedores , IAjuda 

Em todos os módulos procure começar com uma breve descrição sobre o objetivo geral do código , indicando a data , o nome do autor e as revisões realizadas. Algo como:

3- Procedimentos e Funções

Os procedimentos da sua aplicação podem ser privados , públicos ou de eventos , da mesma forma você deve dar um nome sugestivo, incluir comentários , e construir o código com uma estrutura básica que seja de fácil leitura e interpretação  além , é claro , de realizar o tratamento de erros. Aqui algumas sugestões:

1- Ao nomear um procedimento padrão o VB usa automaticamente a sintaxe <objeto>_<ação/evento>. Ex: Text1_Click, Command1_Click . Ao criar seus procedimentos você pode usar o mesmo esquema.

2- Um procedimento para uma Property Public será a interface para as propriedades da classe. Use o nome da propriedade para definí-las sem um prefixo ou sufixo. Ex: CalculoImposto , ValorTotal.

3- Métodos e sub-rotinas Privadas ( Privates ) seguem a sintaxe : <objeto><ação> . Ex: ArquivoAbrir , IdadeCalculo , etc..

4- Todos procedimentos devem ser comentados resumidamente 

5- Utilize Tabs para indentar as estruturas aninhadas. Defina em Tools|Options|Editor|Tab Width com 3/4 caracteres.

6- As linhas de código não devem ser muito longas ; uma linha for muito longa quebre-a em partes usando o caractere ( _ ) 

7- Uma linha de código deve possuir , na medida do possível um comando.

8- O tratamento de erros é um fator crítico em qualquer aplicação. No VB o tratamento de erro é feito a nivel de procedimento. Cada procedimento deve possuir o seu tratamento de erros e  a saída(EXIT)  da rotina deve ser feita em um único lugar . 

Um exemplo padrão seria:

A mensagem de erro também deve ser clara e amigável e não muito técnica de forma que o usuário possa entender.

4- A Sintaxe do VB

Regras Gerais :

1. Todos os módulos devem conter a declaração Option Explicit , com isto o VB obriga você a declarar as variáveis
2. Não use números mágicos que somente tem sentido para você para os mais íntimos com a linguagem. Por exemplo , se você for definir o ponteiro do mouse pode usar Screen.MousePointer = 11 mas fica mais claro se você usar Screen.MousePointer = vbHourGlass como também fica mais claro você usar form1.show vbmodal do que simplesmente tascar form1.show 1
3. Ao usar Select/Case procure sempre usar a opção Case Else , assim se houver uma condição que não seja verificada em uma das declarações Case vai ser difícil você descobrir. Com Case/Else você define um valor padrão para estes casos já previstos.
4. Procure não usar a função IIF , além de não ser muito eficaz , dificulta a leitura do código.
5. Para concatenar strings prefira usar '&' ao invés de '+'
6. Nem pense em usar GOTO
7. Ao declarar variáveis deixe bem claro o escopo das mesmas : Public ou Private
8. Procure definir as variáveis no escopo de menor visibilidade possível . Assim prefira usar variáveis locais
9. Procure restringir o uso de variáveis públicas
10. Declare todas a variáveis locais no início do procedimento

Ao dar nome para sua váriavel adote um esquema padrão . Geralmente o nome é composto por três partes :

1. O prefixo define o ESCOPO da variável. Como sugestão você pode usar:

1. A seguir defina o TIPO da variável. Como sugestão temos:

1. A FUNÇÃO da variável

Exemplos: sNome , l_numero , g_iNumero , st_Escolha

4- Banco de dados , Tabelas , Campos...

Para encerrar algumas regras básicas para trabalhar com variáveis , tabelas , campos , recordsets e banco de dados :

• Procure dar nome a tabelas de forma a identificar o seu propósito : Ex: Clientes , Produtos , Pedidos
• Todas as tabelas deverão conter uma chave primária.(quase sempre)
• Tabelas que se relacionam com chave primária e chave estrangeira deve usar o mesmo nome para as chaves. Assim na tabela Pedido se temos pedidoID na tabela Detalhes a chave estrangeira deverá ser pedidoID
• Ao dar nome aos campos das tabelas procure usar letras maiúsculas nas primeiras letras. Ex: ClienteNome
• Ao dar nome aos campos das tabelas você pode usar como primeiro nome o nome da tabela. Ex: ProdutosCodigo

Espero ter clareado um pouco as coisas com estas sugestões. Como regra máxima use o Bom senso...

             Gostou ?   Compartilhe no Facebook   Compartilhe no Twitter
 

Referências:

• Seção VB .NET do Site Macoratti.net

• Super DVD .NET - A sua porta de entrada na plataforma .NET

• Super DVD Vídeo Aulas - Vídeo Aula sobre VB .NET, ASP .NET e C#

• Seção C# do site Macoratti.net

• Super DVD C#

• Super DVD Visual Basic

• Curso Básico VB .NET - Vídeo Aulas

• Curso C# Básico - Vídeo Aulas

José Carlos Macoratti