Syntaxis van de Help op basis van opmerkingen

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

Syntaxisdiagram

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

# .< help keyword>
# <help content>

-or -

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

Beschrijving van syntaxis

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

Elke sectie van help op basis van opmerkingen wordt gedefinieerd door een trefwoord en elk trefwoord wordt voorafgegaan door een punt ( . ). De trefwoorden kunnen in elke volgorde worden weergegeven. De sleutelwoordnamen zijn niet sleutelwoordgevoelig.

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

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 niet-Help-opmerkingsregel en het begin van de Help op basis van opmerkingen.

Het volgende Help-onderwerp op basis van opmerkingen bevat bijvoorbeeld de . Het sleutelwoord Beschrijving en de waarde ervan, een beschrijving van een functie of script.

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