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

É uma boa ideia para estabelecer as convenções de nomenclatura para o código do Visual Basic. Este artigo fornece as convenções de nomenclatura utilizadas pelos serviços Microsoft consulta (MCS).

Este documento é um vasto conjunto de convenções de codificação do Visual Basic encontrado no Visual Basic "Programmer Guide".

NOTA: Os controlos de outros fabricantes mencionados neste artigo são fabricados por fornecedores independentes da Microsoft. A Microsoft não oferece nenhuma garantia, expressa ou implícita, relativamente ao desempenho ou à fiabilidade destes controlos.

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

• Uniformizar a estrutura lógica de uma aplicação e estilo de codificação.
• Crie código preciso legível e unambiguous.
• seja consistente com outras convenções do idioma (mais importante ainda, o guia de programadores do Visual Basic e notação Húngaro padrão do Windows C).
• ser eficaz a partir de um tamanho da cadeia e vista de mão-de-obra, permitindo uma maior oportunidade para mais e nomes de objectos completa.
• definem os requisitos mínimos necessários para efectuar o acima indicado.

Definir opções de ambiente

Utilize a opção explícita. Declarar todas as variáveis para poupar tempo de programação, reduzindo o número de erros causados por erros de escrita (por exemplo, aUserNameTmp vs. sUserNameTmp vs. sUserNameTemp). Na caixa de diálogo Opções de ambiente, defina a declaração de variável necessária para Sim. A instrução Option Explicit requer que declare as variáveis no programa do Visual Basic. Guarde ficheiros como texto ASCII. Guarde formulário (.FRM) e módulo (.BAS) ficheiros como texto ASCII para facilitar a utilização de sistemas de controlo de versão e minimizar os danos que podem ser provocados por danos no disco. Além disso, pode:

• utilizar o seu próprio editor
• utilizar ferramentas automatizadas, como, por exemplo, grep
• Criar geração de código ou CASE ferramentas para o Visual Basic
• Efectuar análise externo do código Visual Basic

Para guardar sempre os ficheiros como texto ASCII, da caixa de diálogo Opções do ambiente do Visual Basic, defina a opção Guardar como formato predefinido para texto.

Convenções de nomenclatura de objectos para objectos padrão

As seguintes tabelas definem os prefixos de nome de objecto padrão MCS. Estes prefixos são consistentes com os documentadas no manual de programadores do Visual Basic.

Convenção de nomenclatura de objectos para objectos de base de dados

NOTA: A utilizar um sufixo para consultas permite que cada consulta de ser ordenados com a tabela associada no Microsoft Access diálogos (Adicionar tabela, lista de tabelas de Snapshot).

Convenções de nomenclatura de menu

As aplicações utilizam frequentemente uma prosperidade de controlos de menu. Como resultado, necessita de um conjunto de convenções de nomenclatura diferente para estes controlos. Prefixos de controlo de menu devem ser expandidos para além do rótulo mnu inicial, adicionando um prefixo adicional para cada nível de aninhamento, com o título de menu final no fim da cadeia de nome. Por exemplo: quando esta convenção é utilizada, todos os membros de um grupo de menus específica são apresentados lista lado a lado no objecto de caixas de listagem (na janela de propriedades e janela de código) pendente. Além disso, os nomes de controlo de menu documentam claramente os itens de menu ao qual estão ligados.

Convenções de nomenclatura para outros controlos

Para novos controlos não listados acima, tente trazem um prefixo de três caracteres exclusivo. No entanto, é mais importante ser desmarque de ao colar a três caracteres.

Para expandem derivados controlos, tais como uma caixa de lista avançada, os prefixos acima para que haja sem confusão sobre qual o controlo que está realmente a ser utilizado. Uma minúscula abreviatura para o fabricante também normalmente deve ser adicionada ao prefixo. Por exemplo, uma instância do controlo criada a partir do técnico de Visual Basic moldura 3D foi utiliza um prefixo fra3d para evitar confusões através da qual controlo realmente está a ser utilizado. Um botão de comando de MicroHelp poderia utilizar cmdm para diferenciá-lo no botão de comando padrão (cmd).

Controlos de outros fabricantes

Cada controlo de outros fabricantes utilizado numa aplicação deverá estar listado na secção de comentário de descrição geral da aplicação, fornecendo o prefixo utilizado para o controlo, o nome completo do controlo e o nome do fornecedor de software:

Variável e atribuição de nomes de rotina

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

As seguintes tabelas definem variável e função prefixos de nome que se baseiam notação Húngaro C para o Windows. Estes prefixos devem ser utilizados com todas as variáveis e os nomes das funções. Utilização de sufixos base antigas (tal como % &, #, etc.) são a sua utilização.

Variável e prefixos de nome de função: Nota: os valores na coluna Converged representam os esforços para reunir os padrões de nomenclatura do Visual Basic, Visual Basic for Applications e Basic do Access. É provável que estes prefixos ficará padrões da Microsoft em algum momento num futuro próximo.

Âmbito e utilização de prefixos: notação Húngaro é tão importante no Visual Basic porque está a ser C. Embora os sufixos de tipo de Visual Basic indicar o tipo de dados de uma variável, não explicar o que uma variável ou função é utilizada para ou como pode ser acedido. Eis alguns exemplos: Cada um destes nomes variáveis indicam um programador algo muito diferentes. Estas informações são perdidas quando o nome da variável é reduzido para enviar %. Prefixos de âmbito como, por exemplo, g e m também ajudam a reduzir o problema de contenção de nome especialmente em projectos multi-developer.

Notação Húngaro é também muito utilizada pelos programadores de C do Windows e constantemente indicada na documentação dos produtos da Microsoft e livros de programação da indústria. Além disso, o título entre programadores de C e os programadores que utilizam o Visual Basic passa muito mais forte como a expectativa de ganhos Visual C++ sistema de desenvolvimento. Esta transição resultará em muitos programadores de Visual Basic mover e C para a primeira vez e muitos programadores frequentemente mover alternadamente entre ambos os ambientes.

O corpo de variável e nomes de rotina

O corpo de uma variável ou rotina nome deve utilizar maiúsculas e minúsculas e deve ser desde conforme necessário para descrever a respectiva finalidade. Além disso, os nomes das funções deverão começar com um verbo, como, por exemplo, InitNameArray ou CloseDialog.

Para termos frequentemente utilizados ou longos, abreviaturas padrão são recomendadas para ajudar a manter os comprimentos de nome razoável. Em geral, nomes de variáveis superior a 32 caracteres podem ser difícil de ler no apresenta VGA.

Quando utilizar abreviaturas, certifique-se de estão consistentes em toda a aplicação completa. Aleatoriamente alternar entre NOT e contar dentro de um projecto irá conduzir a confusão desnecessário.

Qualificadores de variável e nomes de rotina

Variáveis relacionadas e rotinas frequentemente são utilizadas para gerir e manipular um objecto comuns. Nestes casos, utilize os qualificadores padrão para identificar as variáveis derivadas e rotinas. Apesar de a colocar o qualificador depois do corpo do nome poderá parecer um pouco estranhas (como na sGetNameFirst, sGetNameLast em vez de sGetFirstName, sGetLastName), este procedimento ajudará a ordem lista estes nomes em conjunto na rotina do Visual Basic editor, tornando o lógica e a estrutura da aplicação mais fácil de compreender. A tabela seguinte define qualificadores comuns e respectivo significado padrão:

Tipos definidos pelo utilizador

Declare tipos definidos pelo utilizador em maiúsculas com _TYPE anexado ao fim do nome do símbolo. Por exemplo: quando declarar uma variável de instância de um utilizador definido tipo, adicionar um prefixo ao nome de variável para o tipo de referência. Por exemplo:

Atribuição de nomes de constantes

O corpo da constantes nomes deve estar UPPER_CASE com caracteres de sublinhado (_) entre palavras. Apesar de constantes do Visual Basic padrão não incluem informações húngaro, prefixos como i, s, g e m pode ser muito úteis no Noções sobre o valor e o âmbito de uma constante. Para nomes de constantes, siga as mesmas regras como variáveis. Por exemplo:

Tipo de dados variante

Se souber que uma variável sempre irá armazenar dados de um determinado tipo, Visual Basic pode processar os dados mais eficiente se declarar uma variável desse tipo.

No entanto, o tipo de dados variante pode ser extremamente útil quando trabalha com bases de dados, mensagens, DDE ou OLE. Muitas bases de dados permitem NULL como um valor válido para um campo. O código tem de distinguir entre NULL, 0 (zero) e "" (cadeia em branco). Muitas vezes, estes tipos de operações podem utilizar uma rotina de serviço genérico não necessita de conhecer o tipo de dados que recebe para processar ou a passar nos dados. Por exemplo: o são algumas desvantagens, no entanto, utilizando variantes. Instruções de código que utilizam variantes de, por vezes, podem ser ambíguas para o programador. Por exemplo: os exemplos acima seria muito menos ambíguo e fáceis de ler, depurar e manter se foram utilizadas as rotinas de conversão de tipo de Visual Basic. Por exemplo:

Comentar o código

Todos os procedimentos e funções devem começar com um breve comentário que descreva as características funcionais a rotina (o que acontece). Esta descrição não deverá descrever os detalhes de implementação (como acontece-) porque estas frequentemente mudar ao longo do tempo, resultando em trabalho de manutenção de comentário desnecessários ou pior ainda, comentários errados. O código propriamente dito e quaisquer comentários na linha ou locais necessários vão descrever a implementação.

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

Comentário do cabeçalho rotina blocos deverão ter o aspecto que esta (consulte a secção seguinte "Formatação o código" para obter um exemplo): cada declaração de variável não trivial deverá incluir um comentário na linha que descreve a utilização de variável que está a ser declarada.

Variáveis, controlos e rotinas devem ser designadas suficientemente claramente que na linha comentar só é necessário para detalhes de implementação complexo ou não intuitiva.

Uma descrição de descrição geral da aplicação, enumerar objectos de dados primário, rotinas, algoritmos, de diálogos, dependências de sistema de base de dados e o ficheiro etc. devem ser incluídos no início do módulo .BAS que contém declarações de constantes genéricas do projecto do Visual Basic.

NOTA: A janela Project inerentemente descreve a lista de ficheiros num projecto, para que esta secção de descrição geral só necessita de fornecem informações sobre os ficheiros mais importantes e módulos ou os ficheiros que a janela Project não lista, tais como inicialização (.ini) ou ficheiros de base de dados.

O código de formatação

Uma vez que muitos programadores utilizam ainda apresenta VGA, ecrã imobiliário tem ser conserved quanto possível, permitindo ainda código de formatação para reflectir a estrutura lógica e aninhamento.

Bloco padrão, com base em separador, aninhamento avanços deve ser duas a quatro espaços. Mais de quatro espaços não é necessário e pode causar instruções para ser oculta ou acidentalmente truncado. Menos dois espaços não mostra suficientemente aninhamento lógica. Na Microsoft Knowledge Base, utilizamos um avanço de espaço de três. Utilize a caixa de diálogo Opções do ambiente de para definir a largura predefinida do separador.

O comentário de descrição geral da funcionalidade de uma rotina deve ser indentadas um espaço. As instruções do nível mais elevadas que siga o comentário de descrição geral devem ser com um separador, com cada bloco aninhado indentados um separador adicional. Por exemplo: variáveis e constantes genérico não devem ser agrupados por função em vez de por ser dividir desactivar áreas isoladas ou ficheiros especiais. Constantes genéricos do Visual Basic como AMPULHETA devem ser agrupados num módulo único (VB_STD.BAS) para os manter separado declarações específicas da aplicação.

Operadores

Sempre utilize um "e" comercial (&) quando concatenar cadeias e utilize o sinal de adição (+) ao trabalhar com valores numéricos. Utilizar um sinal de adição (+) com valores não numéricos, pode causar problemas quando a funcionar com duas variantes. Por exemplo:

Âmbito

Variáveis sempre deverão ser definidas com o âmbito mais pequeno possível. As variáveis globais podem criar máquinas de estado enormously complexas e tornar extremamente difícil de entender a lógica de uma aplicação. As variáveis globais também dificultar a reutilização e manutenção do código muito mais. Variáveis no Visual Basic podem ter o âmbito seguinte: na aplicação do Visual Basic, utilize apenas as variáveis globais quando não existe nenhuma outra forma conveniente para partilhar dados entre formulários. Poderá pretender considerar a armazenar informações na propriedade de controlo de um controlo, que pode ser acedido globalmente utilizando a sintaxe form.object.property.

Se tem de utilizar as variáveis globais, é recomendável declarar todas elas num módulo único e agrupá-las pela função. Atribua o módulo de um nome significativo que indica objectivo, como, por exemplo, GLOBAL.BAS.

Com a excepção das variáveis globais (que não devem ser passadas), procedimentos e funções só devem operar em objectos que são transmitidos para as mesmas. As variáveis globais que são utilizadas em rotinas devem ser identificadas na área de comentário geral no início a rotina. Além disso, passe argumentos para subs e funções utilizando ByVal, a menos que explicitamente pretenda alterar o valor do argumento transmitido.

Escreva código modular sempre que possível. Por exemplo, se a aplicação apresenta uma caixa de diálogo, coloque todos os controlos e códigos necessários para efectuar tarefa a caixa de diálogo num único formulário. Isto ajuda a manter o código da aplicação organizado componentes útil e minimiza a sobrecarga de tempo de execução.

Controlos de outros fabricantes

NOTA: Os produtos referidos abaixo são fabricados por fornecedores independentes da Microsoft. A Microsoft não oferece nenhuma garantia, expressa ou implícita, relativa ao desempenho ou fiabilidade destes produtos.

A tabela seguinte lista caracteres de prefixo nome de parte de outros fornecedores padrão para ser utilizado com prefixos de controlo: a tabela seguinte lista prefixos de controlo de outros fabricantes padrão: