Convenciones de estilo para elementos de código y texto

Estos elementos identifican las opciones de código y las variables que se utilizan en la documentación de ayuda. Por lo general, no se incluirían estos símbolos ni elementos de estilo en los archivos de código o de datos. Son solo indicadores visuales.

Convención Explicación

variable

Las variables aparecen en cursiva. Sustituya el valor apropiado para el nombre de la variable.

Para una mayor claridad visual, a veces las variables y otros elementos de código aparecen entre corchetes < >. No es necesario que utilice estos símbolos en el código.

[optional]

Los elementos entre corchetes son opcionales.

(this|that)

Los elementos entre paréntesis indican una opción booleana OR.

literal

Incluya texto o código exactamente como se muestra.

< >

A veces, las variables y otros elementos de código aparecen entre corchetes < >. Se utilizan para mejorar la claridad en bloques de código largos. Si no se indica lo contrario, no incluya estos símbolos en un nombre de archivo de datos o en su contenido.

En esta página