- 09/12/2016
- 2 minutos para leer
-
-
j -
s -
n
-
Esta sección describe la sintaxis de la ayuda basada en comentariosbasados en comentarios.
Diagrama sintáctico
La sintaxis de la ayuda basada en comentarios es la siguiente:
# .< help keyword># <help content>-or -<#.< help keyword>< help content>#>Descripción sintáctica
La ayuda basada en comentarios se escribe como una serie de comentarios. Puede escribir un símbolo de comentario (#) antes de cada línea de comentarios, o puede utilizar los símbolos <# y #> para crear un bloque de comentarios. Todas las líneas dentro del bloque de comentarios se interpretan como comentarios.
Cada sección de la Ayuda basada en comentarios está definida por una palabra clave y cada palabra clave está precedida por un punto(.). Las palabras clave pueden aparecer en cualquier orden. Los nombres de las palabras clave no distinguen entre mayúsculas y minúsculas.
Un bloque de comentarios debe contener al menos una palabra clave de ayuda. Algunas de las palabras clave, como EJEMPLO,pueden aparecer muchas veces en el mismo bloque de comentarios. El contenido de la ayuda para cada palabra clave comienza en la línea que sigue a la palabra clave y puede abarcar varias líneas.
Todas las líneas de un tema de ayuda basado en comentarios deben ser contiguas. Si un tema de Ayuda basado en comentarios sigue a un comentario que no forma parte del tema de Ayuda, debe haber al menos una línea en blanco entre la última línea de comentario que no es de Ayuda y el comienzo de la Ayuda basada en comentarios.