- 09/12/2016
- 2 minuty na przeczytanie
-
-
j -
s -
n
-
Ta sekcja opisuje składnię pomocy opartej na komentarzach.pomocy opartej na komentarzach.
Syntaktyczny schemat
Składnia pomocy opartej na komentarzach jest następująca:
# .< help keyword># <help content>-or -<#.< help keyword>< help content>#>Syntaktyczny opis
Pomoc oparta na komentarzach jest napisana jako seria komentarzy. Możesz wpisać symbol komentarza (#) przed każdą linią komentarza, lub możesz użyć symboli <# i #>, aby utworzyć blok komentarza. Wszystkie linie wewnątrz bloku komentarza są interpretowane jako komentarze.
Każda sekcja pomocy opartej na komentarzach jest określona przez słowo kluczowe, a każde słowo kluczowe jest poprzedzone kropką (.). Słowa kluczowe mogą występować w dowolnej kolejności. W nazwach słów kluczowych nie jest rozróżniana wielkość liter.
Blok komentarza musi zawierać co najmniej jedno słowo kluczowe pomocy. Niektóre słowa kluczowe, takie jak EXAMPLE, mogą pojawić się wiele razy w tym samym bloku komentarza. Zawartość Pomocy dla każdego słowa kluczowego zaczyna się w wierszu po słowie kluczowym i może obejmować wiele wierszy.
Wszystkie wiersze w temacie Pomocy opartym na komentarzu muszą być sąsiadujące. Jeśli temat Pomocy z komentarzem podąża za komentarzem, który nie jest częścią tematu Pomocy, musi być przynajmniej jedna pusta linia pomiędzy ostatnią linią komentarza nie będącego pomocą a początkiem Pomocy z komentarzem.
.