Cómo leer un diagrama de sintaxis

El diagrama de sintaxis muestra cómo especificar un mandato para que el sistema operativo pueda interpretar correctamente lo que se escribe. Lea el diagrama de sintaxis de izquierda a derecha y de arriba a abajo, siguiendo la línea horizontal (la ruta principal).

Símbolos y puntuación

En los diagramas de sintaxis se utilizan los símbolos siguientes:

Símbolo
Descripción
>>
Marca el principio de la sintaxis de mandato.
><
Marca el final de la sintaxis de mandato.

Debe incluir todos los símbolos de puntuación, como dos puntos, comillas y signos menos que se muestran en el diagrama de sintaxis.

Parámetros

En los diagramas de sintaxis se utilizan los siguientes tipos de parámetros.

Parámetro
Descripción
Necesario
Los parámetros necesarios se muestran en la ruta principal.
Opcional
Los parámetros opcionales se muestran debajo de la ruta principal.

Los parámetros se clasifican como palabras clave o variables. Las palabras clave se muestran en letras minúsculas y se pueden especificar en minúscula. Por ejemplo, un nombre de mandato es una palabra clave. Las variables van en cursiva y representan nombres o valores que se suministran.

Ejemplos de sintaxis

En el ejemplo siguiente, el mandato user es una palabra clave. La variable necesaria es id_usuario y la variable opcional es contraseña. Sustituya las variables por sus propios valores.

Leer el esquema de sintaxisOmitir el esquema de sintaxis visual>>-user--id_usuario--+------------+----------------------------><
                     '-contraseña-'
 

Palabras clave necesarias: las palabras clave y variables necesarias aparecen en la línea de ruta principal.

Leer el esquema de sintaxisOmitir el esquema de sintaxis visual>>-palabra_clave_necesaria-------------------------------------><
 

Debe incluir el código de las palabras clave y los valores necesarios.

Seleccione un elemento necesario de la pila: si hay más de una palabra clave o variable mutuamente exclusivas entre las que elegir, se apilarán verticalmente por orden alfanumérico.

Leer el esquema de sintaxisOmitir el esquema de sintaxis visual>>-+-parámetro_necesario_1-+-----------------------------------><
   '-parámetro_necesario_2-'
 

Valores opcionales: las palabras clave y variables opcionales aparecen debajo de la línea de ruta principal.

Leer el esquema de sintaxisOmitir el esquema de sintaxis visual>>-+---------------+-------------------------------------------><
   '-palabra_clave-'
 

Puede determinar no incluir en el código palabras clave y variables opcionales.

Seleccione una palabra clave opcional de una pila: si hay más de una palabra clave o variable opcional mutuamente exclusivas entre las que elegir, se apilarán verticalmente por orden alfanumérico debajo de la línea de ruta principal.

Leer el esquema de sintaxisOmitir el esquema de sintaxis visual>>-+-------------+---------------------------------------------><
   +-parámetro_1-+
   '-parámetro_2-'
 

Variables: una palabra toda en cursiva es una variable. Donde aparece una variable en la sintaxis, debe sustituirla por uno de sus nombres o valores permitidos, como se define en el texto.

Leer el esquema de sintaxisOmitir el esquema de sintaxis visual>>-variable----------------------------------------------------><
 

Caracteres no alfanuméricos: si un diagrama muestra un carácter que no es alfanumérico (como dos puntos, comillas o signos menos), debe codificar el carácter como parte de la sintaxis. En este ejemplo, debe codificar clúster:puerto.

Leer el esquema de sintaxisOmitir el esquema de sintaxis visual>>-clúster:port------------------------------------------------><