- 09/12/2016
- 2 minutes de lecture
-
-
j -
s -
n
-
Cette section décrit la syntaxe de l’aide basée sur les commentaires.de l’aide basée sur les commentaires.
Diagramme syntaxique
La syntaxe de l’aide basée sur les commentaires est la suivante :
# .< help keyword># <help content>-or -<#.< help keyword>< help content>#>Description de la syntaxe
L’aide basée sur les commentaires est rédigée comme une série de commentaires. Vous pouvez saisir un symbole de commentaire (#) avant chaque ligne de commentaires, ou vous pouvez utiliser les symboles <# et #> pour créer un bloc de commentaires. Toutes les lignes du bloc de commentaires sont interprétées comme des commentaires.
Chaque section de l’aide basée sur les commentaires est définie par un mot-clé et chaque mot-clé est précédé d’un point(.). Les mots-clés peuvent apparaître dans n’importe quel ordre. Les noms des mots-clés ne sont pas sensibles à la casse.
Un bloc de commentaires doit contenir au moins un mot-clé d’aide. Certains des mots-clés, comme EXEMPLE,peuvent apparaître plusieurs fois dans le même bloc de commentaires. Le contenu de l’aide pour chaque mot-clé commence sur la ligne qui suit le mot-clé et peut s’étendre sur plusieurs lignes.
Toutes les lignes d’une rubrique d’aide basée sur des commentaires doivent être contiguës. Si une rubrique d’aide basée sur des commentaires suit un commentaire qui ne fait pas partie de la rubrique d’aide, il doit y avoir au moins une ligne vierge entre la dernière ligne de commentaire qui ne fait pas partie de l’aide et le début de l’aide basée sur des commentaires.