Syntaxis van de Help op basis van opmerkingen

In deze sectie wordt de syntaxis van hulp op basis van opmerkingen beschreven.

Syntaxisdiagram

De syntaxis voor Help op basis van opmerkingen is als volgt:

# .< help keyword>
# <help content>

-of-

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

Syntaxisbeschrijving

Help op basis van opmerkingen wordt geschreven als een reeks opmerkingen. U kunt een opmerkingsymbool (#) typen voor elke regel met opmerkingen, of u kunt de <# en #> symbolen gebruiken om een opmerkingenblok te maken. Alle regels in het opmerkingenblok worden geïnterpreteerd als opmerkingen.

Elke sectie van Op opmerkingen gebaseerde Help wordt gedefinieerd door een trefwoord en elk trefwoord wordt voorafgegaan door een punt (.). De trefwoorden kunnen in elke volgorde worden weergegeven. De namen van trefwoorden zijn niet hoofdlettergevoelig.

Een opmerkingenblok moet ten minste één Help-trefwoord bevatten. Sommige trefwoorden, zoals .EXAMPLE, kunnen vaak worden weergegeven in hetzelfde opmerkingenblok. De Help-inhoud voor elk trefwoord begint op de regel na het trefwoord en kan meerdere regels omvatten.

Alle regels in een Help-onderwerp op basis van opmerkingen moeten aaneengesloten zijn. Als een Help-onderwerp op basis van opmerkingen een opmerking volgt die geen deel uitmaakt van het Help-onderwerp, moet er ten minste één lege regel zijn tussen de laatste regel voor niet-Help-opmerkingen en het begin van de Help op basis van opmerkingen.

Het volgende Help-onderwerp op basis van opmerkingen bevat bijvoorbeeld het .DESCRIPTION trefwoord en de bijbehorende waarde. Dit is een beschrijving van een functie of script.

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