Składnia pomocy opartej na komentarzach

W tej sekcji opisano składnię pomocy opartej na komentarzach.

Diagram składniowy

Składnia pomocy opartej na komentarzach jest następująca:

# .< help keyword>
# <help content>

— lub —

<#
.< help keyword>
< help content>
#>

Opis składni

Pomoc oparta na komentarzach jest napisana jako seria komentarzy. Możesz wpisać symbol komentarza (#) przed każdym wierszem komentarzy lub użyć symboli <# i #>, aby utworzyć blok komentarzy. Wszystkie wiersze w bloku komentarza są interpretowane jako komentarze.

Każda sekcja pomocy opartej na komentarzach jest definiowana przez słowo kluczowe, a każde słowo kluczowe jest poprzedzone kropką (.). Słowa kluczowe mogą być wyświetlane w dowolnej kolejności. Nazwy słów kluczowych nie są czułe na wielkość liter.

Blok komentarza musi zawierać co najmniej jedno słowo kluczowe pomocy. Niektóre słowa kluczowe, takie jak .EXAMPLE, mogą pojawiać się wiele razy w tym samym bloku komentarzy. Zawartość Pomocy dla każdego słowa kluczowego rozpoczyna się w wierszu po słowie kluczowym i może obejmować wiele wierszy.

Wszystkie wiersze w temacie Pomocy opartej na komentarzach muszą być ciągłe. Jeśli temat Pomocy opartej na komentarzach jest zgodny z komentarzem, który nie jest częścią tematu Pomocy, musi istnieć co najmniej jeden pusty wiersz między ostatnim wierszem komentarza innego niż Pomoc a początkiem pomocy opartej na komentarzach.

Na przykład poniższy temat pomocy oparty na komentarzach zawiera słowo kluczowe .DESCRIPTION i jego wartość, która jest opisem funkcji lub skryptu.

<#
    .DESCRIPTION
    The Get-Function function displays the name and syntax of all functions in the session.
#>