Megjegyzésalapú súgótémakörök szintaxisa

Ez a szakasz a megjegyzésalapú súgó szintaxisát ismerteti.

Szintaxisdiagram

A megjegyzésalapú súgó szintaxisa a következő:

# .< help keyword>
# <help content>

-vagy-

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

Szintaxis leírása

A megjegyzésalapú súgó megjegyzéssorozatként van megírva. Megjegyzésszimbólumot (#) minden megjegyzéssor elé beírhat, vagy a <# és #> szimbólumokkal megjegyzésblokkot hozhat létre. A megjegyzésblokk összes sorát megjegyzésként értelmezi a rendszer.

A megjegyzésalapú súgó minden szakaszát egy kulcsszó határozza meg, és minden kulcsszót pont (.) előz meg. A kulcsszavak bármilyen sorrendben megjelenhetnek. A kulcsszónevek nem megkülönböztetik a kis- és nagybetűket.

A megjegyzésblokknak tartalmaznia kell legalább egy súgó kulcsszót. Egyes kulcsszavak, például a .EXAMPLE, sokszor megjelenhetnek ugyanabban a megjegyzésblokkban. Az egyes kulcsszavak súgótartalma a kulcsszó utáni sorban kezdődik, és több sorra is kiterjedhet.

A megjegyzésalapú súgótémakör minden sorának egybefüggőnek kell lennie. Ha egy megjegyzésalapú súgótémakör olyan megjegyzést követ, amely nem része a súgótémakörnek, legalább egy üres sornak kell lennie az utolsó nem súgó megjegyzéssor és a megjegyzésalapú súgó kezdete között.

Az alábbi megjegyzésalapú súgótémakör például a .DESCRIPTION kulcsszót és annak értékét tartalmazza, amely egy függvény vagy szkript leírása.

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