INFO: Microsoft Consulting Services convenções de nomeação para o Visual Basic

É uma boa idéia estabelecer convenções de nomenclatura para o seu código do Visual Basic. Este artigo fornece as convenções de nomenclatura usadas pelo Microsoft Consulting Services (MCS).

Este documento é um superconjunto de convenções de codificação do Visual Basic encontrado no Visual Basic "Guia do programador do".

Observação: Os controles de terceiros mencionados neste artigo são fabricados por fornecedores independentes da Microsoft. A Microsoft não oferece garantia, implícita ou não, em relação ao desempenho ou à confiabilidade desses controles.

Convenções de nomenclatura ajudam os programadores de Visual Basic:

• Padronize a estrutura, estilo e a lógica de um aplicativo de codificação.
• Crie código-fonte precisa, legível e inequívoca.
• seja consistente com outras convenções do idioma (o mais importante é que o guia de programadores de Visual Basic e padrão notação húngara Windows C).
• seja eficiente de um tamanho de seqüência de caracteres e ponto de vista mão-de-obra, permitindo uma maior oportunidade de mais e mais nomes de objeto.
• definem os requisitos mínimos necessários para fazer acima.

Definindo opções de ambiente

Use a opção EXPLICIT. Declarar todas as variáveis para economizar tempo de programação, reduzindo o número de bugs causados por erros de ortografia (por exemplo, aUserNameTmp vs. sUserNameTmp versus sUserNameTemp). Na caixa de diálogo Opções de ambiente, defina Solicitar declaração de variável como Sim. A instrução Option Explicit requer que você declare as variáveis em seu programa do Visual Basic. Salve arquivos como texto ASCII. Salve formulário (.FRM) e o módulo (.BAS) arquivos como texto ASCII para facilitar o uso de sistemas de controle de versão e minimizar os danos que podem ser causados por corrupção do disco. Além disso, você pode:

• Use seu próprio editor
• usar ferramentas automatizadas, como o grep
• criar ferramentas CASE ou geração de código para o Visual Basic
• Executar análise externa de seu código do Visual Basic

Para que sempre salvar arquivos como texto ASCII, na caixa de diálogo Opções de ambiente do Visual Basic, defina a opção Salvar como formato padrão para texto.

Objeto convenções de nomeação para objetos padrão

As tabelas a seguintes definem os prefixos de nome de objeto padrão de MCS. Esses prefixos são consistentes com aquelas documentadas no guia de programadores do Visual Basic.

Objeto convenção de nomenclatura para objetos de banco de dados

Observação: Usando um sufixo para consultas permite que cada consulta para ser classificados com sua tabela associada em caixas de diálogo Microsoft Access (Adicionar tabela, lista de tabelas Snapshot).

Convenções de nome de menu

Os aplicativos usam com freqüência uma abundância de controles de menu. Como resultado, você precisa de um conjunto diferente de convenções de nomenclatura para esses controles. Prefixos de controle de menu devem ser estendidos além do rótulo mnu inicial, adicionando um prefixo adicional para cada nível de aninhamento, com a legenda do menu final no final da seqüência de nome. Por exemplo: quando esta convenção é usada, todos os membros de um grupo menu específico são listados ao lado uns dos outros no objeto caixas de listagem (na janela de código e na janela de propriedade) suspensa. Além disso, os nomes de controle de menu documentam claramente os itens de menu ao qual eles estão conectados.

Convenções de nomenclatura para outros controles

Para novos controles não listados acima, tente acompanham um prefixo de três caracteres exclusivo. No entanto, é mais importante ser desmarque que ao usar três caracteres.

Para estendem controles derivados, como uma caixa de listagem avançada, os prefixos acima para que não haja nenhum confusão sobre qual controle está realmente sendo usado. Uma abreviação de minúscula para o fabricante também normalmente seria adicionada para o prefixo. Por exemplo, uma instância do controle criada a partir do Professional Visual Basic quadro 3D foi usa um prefixo de fra3d para evitar confusão sobre os quais o controle realmente está sendo usado. Um botão de comando do MicroHelp poderia usar cmdm para diferenciá-lo do botão de comando padrão (cmd).

Controles de terceiros

Cada controle de terceiros usado em um aplicativo deve constar na seção de comentário de visão geral do aplicativo, fornecendo o prefixo usado para o controle, o nome completo do controle e o nome do fornecedor do software:

Nomeação de rotina e variável

Nomes de variável e função têm a seguinte estrutura: <prefix><body><qualifier><suffix> prefixos:

As tabelas a seguintes definem prefixos de nome de variável e a função são baseados em notação húngara C para o Windows. Esses prefixos devem ser usados com todas as variáveis e nomes de função. Uso de sufixos básicos antigos (como %, &, #, etc.) são desencorajado.

Variável e prefixos de nome de função: Observação: os valores na coluna Converged representam os esforços para reunir os padrões de nomes para Visual Basic, Visual Basic for Applications e Access Basic. É provável que esses prefixos tornará padrões da Microsoft em algum momento no futuro próximo.

Escopo e prefixos de uso: notação húngara é como valiosa no Visual Basic como no C. Embora os sufixos de tipo do Visual Basic tenha indicado tipo de dados de uma variável, eles não explicam que uma variável ou função é usada, ou como ele pode ser acessado. Aqui estão alguns exemplos: Cada um desses nomes variáveis algo muito diferente Informe um programador. Essas informações são perdidas quando o nome da variável é reduzido para enviar %. Prefixos de escopo como g e m também ajudam a reduzir o problema de contenção de nome especialmente em vários projetos.

Notação húngara também amplamente usada pelo Windows C programadores e constantemente mencionada na documentação do produto Microsoft e no setor livros de programação. Além disso, se o vínculo entre os programadores C e programadores que usam o Visual Basic tornará muito mais seguro como a Visual C++ desenvolvimento sistema ganhos força. Essa transição resultará em muitos programadores de Visual Basic movendo a C para a primeira vez e muitos programadores com freqüência mover para frente e para trás entre os dois ambientes.

O corpo da variável e nomes de rotina

O corpo de uma variável ou rotina nome deve usar maiúsculas e minúsculas e deve ser tão longo quanto necessário para descrever sua finalidade. Além disso, os nomes de função devem começar com um verbo, como InitNameArray ou CloseDialog.

Para termos usados com freqüência ou longos, abreviações padrão são recomendadas para ajudar a manter comprimentos de nome razoável. Em geral, nomes de variáveis maiores que 32 caracteres podem ser difícil ler em monitores VGA.

Ao usar abreviações, certifique-se de que eles são consistentes em todo o aplicativo inteiro. Alternando aleatoriamente Not e Count dentro de um projeto irá causar confusão desnecessária.

Qualificadores de variável e nomes de rotina

Variáveis relacionadas e rotinas costumam ser usadas para gerenciar e manipular um objeto comum. Nesses casos, use os qualificadores padrão para rotular as variáveis derivadas e rotinas. Embora colocando o qualificador após o corpo do nome pode parecer um pouco estranho (como em sGetNameFirst, sGetNameLast em vez de sGetFirstName, sGetLastName), essa prática ajudará a ordem lista esses nomes juntos na rotina Visual Basic editor, tornar mais fácil compreender a lógica e estrutura do aplicativo. A tabela a seguir define os qualificadores comuns e seus significados padrão:

Tipos definidos pelo usuário

Declare tipos definidos pelo usuário em todas em maiúsculas com _TYPE acrescentado ao final do nome do símbolo. Por exemplo: quando declarar uma variável de instância de um usuário definida tipo, adicionar um prefixo ao nome de variável para o tipo de referência. Por exemplo:

Constantes de nomeação

O corpo de nomes de constantes deve ser UPPER_CASE com sublinhados (_) entre as palavras. Embora padrão constantes do Visual Basic não incluem informações húngaras, prefixos como i, s, g e m pode ser muito útil em entender o valor e o escopo de uma constante. Para nomes de constantes, siga as mesmas regras como variáveis. Por exemplo:

Tipo de dados Variant

Se você souber que uma variável sempre irá armazenar dados de um determinado tipo, o Visual Basic pode manipular os dados com mais eficiência se você declarar uma variável do tipo.

No entanto, o tipo de dados variant pode ser extremamente útil ao trabalhar com bancos de dados, mensagens, DDE ou OLE. Muitos bancos de dados permitem NULL como um valor válido para um campo. Seu código precisa para distinguir entre NULL, 0 (zero), e "" (cadeia de caracteres em branco). Muitas vezes, esses tipos de operações podem usar uma rotina de serviço genérico que não precisa saber o tipo de dados que recebe a processar ou passar os dados. Por exemplo: o são algumas desvantagens, no entanto, usando variantes. Instruções de código que usam variantes, às vezes, podem ser ambíguas para o programador. Por exemplo: os exemplos acima seria muito menos ambíguo e mais fácil de ler, depurar e manter se as rotinas de conversão de tipo do Visual Basic foram usadas em vez disso. Por exemplo:

Comentando o código

Todas as funções e procedimentos devem começar com um breve comentário que descreve as características funcionais de rotina (o que ele faz). Essa descrição não deve descrever os detalhes de implementação (como ele faz isso) porque essas geralmente alteram ao longo do tempo, resultando em trabalho de manutenção de comentário desnecessários ou pior ainda, comentários errados. O próprio código e os comentários in-line ou locais necessários descreverá a implementação.

Parâmetros passados para uma rotina devem ser descritos quando suas funções não são óbvias e quando a rotina espera os parâmetros para estar em um intervalo específico. Função retornar valores e variáveis globais que são alteradas pela rotina (especialmente por meio de parâmetros de referência) também devem ser descritas no início de cada rotina.

Comentário do cabeçalho rotina blocos devem parecer como este (consulte a próxima seção "Formatação código O" para obter um exemplo): cada declaração de variável não trivial deve incluir um comentário in-line que descreve o uso de variável que está sendo declarado.

Variáveis, controles e rotinas devem ser nomeadas claramente suficiente que comentários in-line é necessário apenas para detalhes de implementação complexos ou não-intuitiva.

Uma descrição de visão geral do aplicativo, enumerar objetos de dados primária, rotinas, algoritmos, diálogos, dependências de sistema de banco de dados e arquivo e assim por diante devem ser incluído no início do módulo .BAS que contém declarações de constantes genéricas de Visual Basic do projeto.

Observação: A janela Project inerentemente descreve a lista de arquivos em um projeto, portanto, esta seção de visão geral somente precisa fornecer informações sobre os arquivos mais importantes e módulos ou os arquivos que a janela de projeto não lista, como inicialização (inicialização) ou arquivos de banco de dados.

Seu código de formatação

Como muitos programadores usam ainda exibe VGA, imóveis tela deve ser conserved tanto quanto possível, permitindo ainda para refletir a estrutura lógica e o aninhamento de formatação de código.

Bloco padrão, guia aninhamento recuos deve conter duas a quatro espaços. Mais de quatro espaços é desnecessários e pode causar instruções para ser ocultos ou acidentalmente truncados. Menos de dois espaços não mostra suficientemente aninhamento de lógica. Na Base de dados de Conhecimento da Microsoft, usamos um recuo de espaço de três. Use a caixa de diálogo Opções de ambiente para definir a largura da tabulação padrão.

O comentário de visão geral sobre funcional de uma rotina deve ser recuado um espaço. As instruções de nível mais altos que execute o comentário de visão geral devem ser recuada uma guia, com cada bloco aninhado recuado em uma guia adicional. Por exemplo: variáveis e constantes de não-genéricas devem ser agrupados por função em vez de por que está sendo dividida desativar áreas isoladas ou arquivos especiais. Constantes genéricos do Visual Basic, como AMPULHETA devem ser agrupados em um módulo único (VB_STD.BAS) para mantê-los separado do declarações específicas do aplicativo.

Operadores

Sempre use um e comercial (&) quando concatenando cadeias de caracteres e use o sinal de mais (+) ao trabalhar com valores numéricos. Usar um sinal de mais (+) com valores não-numéricos, pode causar problemas durante a operação em duas variantes. Por exemplo:

Escopo

Variáveis sempre devem ser definidas com o menor escopo possível. Variáveis globais possam criar máquinas de estado extremamente complexo e fazer a lógica de um aplicativo extremamente difícil de entender. Variáveis globais também dificultam a reutilização e a manutenção do seu código muito mais. Variáveis no Visual Basic podem ter o escopo a seguir: em um aplicativo Visual Basic, use somente as variáveis globais quando não houver nenhuma outra maneira conveniente para compartilhar dados entre formulários. Talvez você queira armazenar informações na propriedade de marca do controle, que pode ser acessados globalmente usando a sintaxe form.object.property.

Se você deve usar variáveis globais, é recomendável para declarar todos eles em um único módulo e agrupá-los pela função. Dar o módulo de um nome significativo que indica sua finalidade, como GLOBAL.BAS.

Com exceção de funções, procedimentos e variáveis globais (que não devem ser passadas) só devem operar em objetos que são passados para eles. Variáveis globais que são usados em rotinas devem ser identificados na área de comentário geral no início da rotina. Além disso, passe argumentos para sub-rotinas e funções usando ByVal, a menos que explicitamente deseje alterar o valor de argumento transmitido.

Escreva código modular sempre que possível. Por exemplo, se seu aplicativo exibe uma caixa de diálogo, coloque todos os controles e código necessários para executar tarefas da caixa de diálogo em um único formulário. Isso ajuda a manter o código do aplicativo organizado em componentes úteis e minimiza a sobrecarga de tempo de execução.

Controles de terceiros

Observação: Os produtos discutidos abaixo são fabricados por fornecedores independentes da Microsoft. A Microsoft não oferece garantia, implícita ou não, em relação ao desempenho ou à confiabilidade desses produtos.

A tabela a seguir lista fornecedor de terceiros padrão nome prefixo caracteres a ser usado com prefixos de controle: a tabela a seguir lista prefixos de controle padrão de terceiros: