- 09/12/2016
- 2 Minuten zum Lesen
-
-
j -
s -
n
-
Dieser Abschnitt beschreibt die Syntax der Kommentar-basierten Hilfe.
Syntaxdiagramm
Die Syntax der kommentarbasierten Hilfe sieht wie folgt aus:
# .< help keyword># <help content>-or -<#.< help keyword>< help content>#>Syntaxbeschreibung
Kommentarbasierte Hilfe wird als eine Reihe von Kommentaren geschrieben. Sie können ein Kommentarsymbol (#) vor jede Kommentarzeile setzen, oder Sie können die Symbole <# und #> verwenden, um einen Kommentarblock zu erstellen. Alle Zeilen innerhalb des Kommentarblocks werden als Kommentare interpretiert.
Jeder Abschnitt der kommentarbasierten Hilfe wird durch ein Schlüsselwort definiert und jedem Schlüsselwort wird ein Punkt vorangestellt(.). Die Schlüsselwörter können in beliebiger Reihenfolge erscheinen. Groß- und Kleinschreibung werden nicht unterschieden.
Ein Kommentarblock muss mindestens ein Hilfeschlüsselwort enthalten. Einige der Schlüsselwörter, wie z. B. BEISPIEL, können mehrmals im selben Kommentarblock vorkommen. Der Hilfeinhalt für jedes Schlüsselwort beginnt in der Zeile nach dem Schlüsselwort und kann sich über mehrere Zeilen erstrecken.
Alle Zeilen in einem kommentarbasierten Hilfethema müssen zusammenhängend sein. Wenn ein kommentarbasiertes Hilfethema auf einen Kommentar folgt, der nicht Teil des Hilfethemas ist, muss mindestens eine Leerzeile zwischen der letzten Nicht-Hilfe-Kommentarzeile und dem Beginn der kommentarbasierten Hilfe liegen.