Convenciones de estilo para elementos de código y texto style-conventions-for-code-and-text-elements

Estos elementos identifican las opciones de código y las variables utilizadas en la documentación de ayuda. Por lo general, no se incluyen estos símbolos ni elementos de estilo en los archivos de código o datos. Solo son indicadores visuales.

Convención
Explicación
variable

Las variables aparecen en cursiva. Sustituya el valor apropiado por 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 utilizar estos símbolos en el código.

[optional]
Los elementos entre corchetes son opcionales.
(this|that)
Los elementos entre paréntesis indican un valor booleano O elección.
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 el nombre del archivo de datos o en su contenido.
recommendation-more-help
de293fbf-b489-49b0-8daa-51ed303af695