Delen via

Typen hulp in PowerShell

Het PowerShell-helpsysteem ondersteunt twee soorten hulp.

  • Conceptuele Help-artikelen waarin concepten en gebruiksscenario's worden beschreven.
  • Help-artikelen voor opdrachten waarin de syntaxis en het gebruik van cmdlets, functies en scripts worden beschreven.

De PlatyPS-module helpt u bij het maken en verpakken van PowerShell-helpbestanden voor uw modules.

Conceptuele ("over") help-tekstbestanden

Conceptuele ("over") Help-artikelen beschrijven de module, de leden (zoals opdrachten en variabelen) en leggen uit hoe de leden samen kunnen worden gebruikt om taken uit te voeren. De Help-artikelen over zijn platte tekstbestanden. De PlatyPS-module helpt u niet bij het maken van deze bestanden, maar kan ze wel verpakken met de opdrachthelpbestanden voor modules die updatebare hulp ondersteunen.

Zie Hulp bij het schrijven van PowerShell-modules voor meer informatie over het maken van conceptuele Help-artikelen.

Hulp bij opdrachten

In Help-artikelen voor opdrachten worden de syntaxis en het gebruik van cmdlets, functies en scripts beschreven. Command help kan op twee manieren worden geïmplementeerd:

  • Help op basis van opmerkingen die is ingesloten in het script of de functie.
  • Help op basis van XML die is opgeslagen in een extern XML-bestand.

Hulp bij opdrachten op basis van opmerkingen

Voor PowerShell-scripts en -functies kunt u Help op basis van opmerkingen rechtstreeks in het bronbestand van het script of de functie schrijven. Help op basis van opmerkingen maakt gebruik van speciale trefwoorden voor opmerkingen die door PowerShell worden herkend. PowerShell extraheert de op opmerkingen gebaseerde Help uit het script of de functie voor presentatie door de Get-Help cmdlet. Zie de volgende artikelen voor meer informatie over het schrijven van Help-artikelen op basis van opmerkingen:

Help bij XML-opdrachten

Het PowerShell-helpsysteem biedt ook ondersteuning voor de Help-bestanden die zijn geschreven in de MAML-indeling (Microsoft Assistance Markup Language). MAML is een op XML gebaseerd schema dat wordt gebruikt om Help-documentatie te maken. MAML is de enige manier om hulp te maken voor cmdlets die zijn geïmplementeerd in binaire modules. Dit is ook het formaat dat vereist is voor modules die updatebare hulp ondersteunen.

U kunt MAML gebruiken om Help te maken voor scripts en functies. Help op basis van opmerkingen heeft echter voorrang op Help op basis van XML wanneer beide typen hulp aanwezig zijn, tenzij u het .EXTERNALHELP trefwoord voor opmerkingen gebruikt. Wanneer het .EXTERNALHELP trefwoord voor opmerkingen aanwezig is, heeft dit voorrang op hulp op basis van opmerkingen, zelfs als Get-Help er geen Help-bestand kan worden gevonden dat in de .EXTERNALHELP opmerking is opgegeven. Zie Het Help-bestand van de cmdlet maken voor meer informatie over het schrijven van Help-artikelen op basis van XML.

Handschrift MAML is vervelend en foutgevoelig. Met de PlatyPS-module kunt u uw opdrachtdocumentatie in Markdown schrijven en vervolgens in het MAML-formaat compileren. Zie Nieuwe Markdown-hulp maken met PlatyPS voor meer informatie over het gebruik van PlatyPS.

  • Last updated on