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

  • Artigo

A documentação do Visual Basic usa as seguintes convenções tipográficas e de código.

Convenções tipográficas

Exemplo Description
Sub, If, ChDir, Print, True, Debug Palavras-chave específicas do idioma e membros do tempo de execução têm letras maiúsculas iniciais e são formatados como mostrado neste exemplo.
SmallProject, ButtonCollection As palavras e frases que você é instruído a digitar são formatadas como mostrado neste exemplo.
Declaração do módulo Os links nos quais você pode clicar para ir para outra página de Ajuda são formatados conforme mostrado neste exemplo.
objeto, variableName, argumentList Os espaços reservados para as informações fornecidas são formatados conforme mostrado neste exemplo.
[ Sombras ], [ expressionList ] Na sintaxe, os itens opcionais são colocados entre parênteses.
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 de itens ou nenhum item.
[{ ByVal | ByRef }] Na sintaxe, quando você não pode selecionar mais de um item, mas também pode omitir os itens completamente, 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, como mostrado no exemplo.
nomedomembro1

...

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

No código, as elipses significam código omitido por uma questão de clareza.
ESC, DIGITE Os nomes de teclas e as sequências de teclas no teclado aparecem em letras maiúsculas.
ALT+F1 Quando os sinais de adição (+) aparecem entre os nomes das chaves, você deve manter pressionada 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 Description
sampleString = "Hello, world!" Os exemplos de código aparecem em uma fonte de passo fixo e são formatados como mostrado neste exemplo.
A instrução anterior define o valor de sampleString "Olá, mundo!" Os elementos de código no texto explicativo aparecem em uma fonte de passo fixo, como 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 de um sublinhado ( _) no final de uma linha indica que a instrução continua na linha seguinte.

Consulte também