Compartilhar via


Convenções tipográficas e de código (Visual Basic)

A documentação do Visual Basic usa as convenções de código e tipo a seguir.

Convenções tipográficas

Exemplo Descrição
Sub, If, ChDir, Print, , TrueDebug Palavras-chave específicas do idioma e membros de runtime têm letras maiúsculas iniciais e são formatadas conforme mostrado neste exemplo.
SmallProject, ButtonCollection Palavras e frases que você é instruído a digitar são formatadas conforme mostrado neste exemplo.
Instrução do Módulo Os links que você pode clicar para ir para outra página da Ajuda são formatados, conforme mostrado neste exemplo.
object, variableName, argumentList Os espaços reservados para informações fornecidas são formatados conforme mostrado neste exemplo.
[ Sombras ], [ expressionList ] Na sintaxe, os itens opcionais são colocados entre colchetes.
{ Public | | FriendPrivate } Na sintaxe, quando você deve fazer uma escolha entre dois ou mais itens, os itens são colocados entre chaves e separados por barras verticais.

Você deve selecionar um e apenas um dos itens.
[ Protected | Friend ] Na sintaxe, quando você tem a opção de selecionar entre dois ou mais itens, os itens são colocados entre colchetes e separados por barras verticais.

Você pode selecionar qualquer combinação dos itens ou nenhum item.
[{ ByVal | ByRef }] Na sintaxe, quando você pode selecionar não mais do que um item, mas também pode omitir completamente os itens, os itens são colocados entre colchetes cercados por chaves e separados por barras verticais.
memberName1, memberName2, memberName3 Várias instâncias do mesmo espaço reservado são diferenciadas por subscritos, conforme mostrado no exemplo.
memberName1

...

memberNameN
Na sintaxe, uma reticências (...) é usada para indicar um número indefinido de itens do tipo imediatamente na frente das reticências.

No código, as reticências significam código omitido para fins de clareza.
ESC, ENTER Os nomes de teclas e as sequências de teclas no teclado aparecem em todas as letras maiúsculas.
ALT+F1 Quando sinais de adição (+) aparecem entre nomes de chave, você deve segurar uma tecla enquanto pressiona a outra. Por exemplo, ALT+F1 significa manter pressionada a tecla ALT enquanto pressiona a tecla F1.

Convenções de código

Exemplo Descrição
sampleString = "Hello, world!" Exemplos de código aparecem em uma fonte de tom fixo e são formatados conforme mostrado neste exemplo.
A instrução anterior define o valor de sampleString "Olá, mundo!" Elementos de código em texto explicativo aparecem em uma fonte de tom fixo, conforme mostrado neste exemplo.
' This is a comment.

REM This is also a comment.
Os comentários de código são introduzidos por um apóstrofo (') ou pela palavra-chave REM.
sampleVar = "This is an " _

& "example" _

& " of how to continue code."
Um espaço seguido por um sublinhado (_) no final de uma linha indica que a instrução continua na linha a seguir.

Consulte também