Convenciones tipográficas y de código (Visual Basic)

  • Artículo

La documentación de Visual Basic usa las siguientes convenciones tipográficas y de código.

Convenciones tipográficas

Ejemplo Descripción
Sub, If, ChDir, Print, True, Debug Los miembros del entorno de ejecución y las palabras clave específicas del lenguaje tienen letras mayúsculas iniciales y el formato que se muestra en este ejemplo.
SmallProject, ButtonCollection Las palabras y frases que se le indica que escriba tienen el formato que se muestra en este ejemplo.
Module (Instrucción) Los vínculos a los que puede hacer clic para ir a otra página de ayuda tienen el formato que se muestra en este ejemplo.
objeto, nombreDeVariable, argumentList Los marcadores de posición para obtener la información que proporcione tienen el formato que se muestra en este ejemplo.
[ Shadows ], [ listaExpresiones ] En la sintaxis, los elementos opcionales se incluyen entre corchetes.
{ Public | Friend | Private } En la sintaxis, cuando debe elegir entre dos o más elementos, los elementos se incluyen entre llaves y separados por barras verticales.

Debe seleccionar uno y solo uno de los elementos.
[ Protected | Friend ] En la sintaxis, cuando tiene la opción de seleccionar entre dos o más elementos, los elementos se incluyen entre corchetes y separados por barras verticales.

Puede seleccionar cualquier combinación de los elementos o ningún elemento.
[{ ByVal | ByRef }] En la sintaxis, cuando solo puede seleccionar un elemento, pero también puede omitir los elementos por completo, los elementos se incluyen entre corchetes rodeados de llaves y separados por barras verticales.
nombreDeMiembro1, nombreDeMiembro2, nombreDeMiembro3 Varias instancias del mismo marcador de posición se diferencian por subíndices, como se muestra en el ejemplo.
nombreDeMiembro1

...

nombreDeMiembroN		 En la sintaxis, se usa un botón de puntos suspensivos (...) para indicar un número indefinido de elementos del tipo inmediatamente anterior a los puntos suspensivos.

En el código, los puntos suspensivos indican código omitido por motivos de claridad.
ESC, ENTRAR Los nombres de teclas y las secuencias de teclas del teclado aparecen completamente en letras mayúsculas.
ALT+F1 Cuando aparezcan signos más (+) entre los nombres de clave, debe mantener presionada una tecla mientras presiona la otra. Por ejemplo, ALT+F1 significa mantener presionada la tecla ALT mientras presiona la tecla F1.

Convenciones de código

Ejemplo Descripción
sampleString = "Hello, world!" Los ejemplos de código aparecen en una fuente de paso fijo y tienen el formato que se muestra en este ejemplo.
La instrucción anterior establece el valor de sampleString en "Hello, world!" (¡Hola, mundo!) Los elementos de código del texto explicativo aparecen en una fuente de paso fijo, como se muestra en este ejemplo.
' This is a comment.

REM This is also a comment.		 Los comentarios de código se introducen mediante un apóstrofo (') o la palabra clave REM.
sampleVar = "This is an " _

& "example" _

& " of how to continue code."		 Un espacio seguido de un carácter de subrayado ( _) al final de una línea indica que la instrucción continúa en la línea siguiente.

Vea también