Syntax för kommentarsbaserad hjälp

I det här avsnittet beskrivs syntaxen för kommentarsbaserad hjälp.

Syntaxdiagram

Syntaxen för kommentarsbaserad hjälp är följande:

# .< help keyword>
# <help content>

-eller-

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

Syntaxbeskrivning

Kommentarsbaserad hjälp skrivs som en serie kommentarer. Du kan skriva en kommentarssymbol (#) före varje kommentarsrad, eller så kan du använda symbolerna <# och #> för att skapa ett kommentarsblock. Alla rader i kommentarsblocket tolkas som kommentarer.

Varje avsnitt i kommentarsbaserad hjälp definieras av ett nyckelord och varje nyckelord föregås av en punkt (.). Nyckelorden kan visas i valfri ordning. Nyckelordsnamnen är inte skiftlägeskänsliga.

Ett kommentarsblock måste innehålla minst ett hjälpnyckelord. Vissa av nyckelorden, till exempel .EXAMPLE, kan visas många gånger i samma kommentarsblock. Hjälpinnehållet för varje nyckelord börjar på raden efter nyckelordet och kan sträcka sig över flera rader.

Alla rader i ett kommentarsbaserat hjälpavsnitt måste vara sammanhängande. Om ett kommentarsbaserat hjälpavsnitt följer en kommentar som inte ingår i hjälpavsnittet måste det finnas minst en tom rad mellan den sista kommentarsraden som inte är hjälp och början av den kommentarsbaserade hjälpen.

Följande kommentarsbaserade hjälpavsnitt innehåller till exempel nyckelordet .DESCRIPTION och dess värde, vilket är en beskrivning av en funktion eller ett skript.

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