Comment-Based Help-trefwoorden

In dit onderwerp worden de trefwoorden in hulp op basis van opmerkingen vermeld en beschreven.

Trefwoorden in Comment-Based Help

Hieronder ziet u geldige Help-trefwoorden op basis van opmerkingen. Ze worden vermeld in de volgorde waarin ze meestal worden weergegeven in een Help-onderwerp, samen met het beoogde gebruik. Deze trefwoorden kunnen in elke volgorde worden weergegeven in de Help op basis van opmerkingen en ze zijn niet hoofdlettergevoelig.

Houd er rekening mee dat het .EXTERNALHELP trefwoord voorrang heeft op alle andere help-trefwoorden op basis van opmerkingen. Wanneer .EXTERNALHELP aanwezig is, geeft de cmdlet Get-Help- geen hulp op basis van opmerkingen weer, zelfs niet wanneer er geen Help-bestand kan worden gevonden dat overeenkomt met de waarde van het trefwoord.

.SYNOPSIS

Een korte beschrijving van de functie of het script. Dit trefwoord kan slechts eenmaal in elk onderwerp worden gebruikt.

.DESCRIPTION

Een gedetailleerde beschrijving van de functie of het script. Dit trefwoord kan slechts eenmaal in elk onderwerp worden gebruikt.

.PARAMETER <Parameter-Name>

De beschrijving van een parameter. U kunt een .PARAMETER trefwoord voor elke parameter in de functie of het script opnemen.

De .PARAMETER trefwoorden kunnen in elke volgorde in het opmerkingenblok worden weergegeven, maar de volgorde waarin de parameters worden weergegeven in de instructie param of functiedeclaratie bepaalt de volgorde waarin de parameters worden weergegeven in het Help-onderwerp. Als u de volgorde van parameters in het Help-onderwerp wilt wijzigen, wijzigt u de volgorde van de parameters in de param-instructie of functiedeclaratie.

U kunt ook een parameterbeschrijving opgeven door een opmerking in de instructie param direct vóór de naam van de parametervariabele te plaatsen. Als u zowel een opmerking van een param instructie als een .PARAMETER trefwoord gebruikt, wordt de beschrijving die aan het .PARAMETER trefwoord is gekoppeld, gebruikt en wordt de opmerking van de param instructie genegeerd.

.EXAMPLE

Een voorbeeldopdracht die gebruikmaakt van de functie of het script, eventueel gevolgd door voorbeelduitvoer en een beschrijving. Herhaal dit trefwoord voor elk voorbeeld.

.INPUTS

De .NET-typen objecten die kunnen worden doorgesluisd naar de functie of het script. U kunt ook een beschrijving van de invoerobjecten opnemen. Herhaal dit trefwoord voor elk invoertype.

.OUTPUTS

Het .NET-type van de objecten die door de cmdlet worden geretourneerd. U kunt ook een beschrijving van de geretourneerde objecten opnemen. Herhaal dit trefwoord voor elk uitvoertype.

.NOTES

Aanvullende informatie over de functie of het script.

.LINK

De naam van een gerelateerd onderwerp. Herhaal dit trefwoord voor elk gerelateerd onderwerp. Deze inhoud wordt weergegeven in de sectie Verwante koppelingen van het Help-onderwerp.

De .LINK trefwoordinhoud kan ook een URI (Uniform Resource Identifier) bevatten naar een onlineversie van hetzelfde Help-onderwerp. De onlineversie wordt geopend wanneer u de parameter Online van Get-Helpgebruikt. De URI moet beginnen met http of https.

.COMPONENT

De naam van de technologie of functie die door de functie of het script wordt gebruikt of waaraan deze is gerelateerd. De parameter Component van Get-Help gebruikt deze waarde om de zoekresultaten te filteren die worden geretourneerd door Get-Help.

.ROLE

De naam van de gebruikersrol voor het Help-onderwerp. De parameter Role van Get-Help gebruikt deze waarde om de zoekresultaten te filteren die worden geretourneerd door Get-Help.

.FUNCTIONALITY

De trefwoorden die het beoogde gebruik van de functie beschrijven. De parameter Functionality van Get-Help gebruikt deze waarde om de zoekresultaten te filteren die worden geretourneerd door Get-Help.

.FORWARDHELPTARGETNAME <Command-Name>

Wordt omgeleid naar het Help-onderwerp voor de opgegeven opdracht. U kunt gebruikers omleiden naar elk Help-onderwerp, inclusief Help-inhoud voor een functie, script, cmdlet of provider.

# .FORWARDHELPTARGETNAME <Command-Name>

.FORWARDHELPCATEGORY

Hiermee specificeert u de helponderwerpcategorie van het item in .FORWARDHELPTARGETNAME. Geldige waarden zijn Alias, Cmdlet, HelpFile, Function, Provider, General, FAQ, Glossary, ScriptCommand, ExternalScript, Filterof All. Gebruik dit trefwoord om conflicten te voorkomen wanneer er opdrachten met dezelfde naam zijn.

# .FORWARDHELPCATEGORY <Category>

.REMOTEHELPRUNSPACE <PSSession-variable>

Hiermee geeft u een sessie op die het Help-onderwerp bevat. Voer een variabele in die een PSSession--object bevat. Dit trefwoord wordt gebruikt door de cmdlet [Export-PSSession][09] om de Help-inhoud voor de geëxporteerde opdrachten te vinden.

# .REMOTEHELPRUNSPACE <PSSession-variable>

.EXTERNALHELP

Hiermee specificeer je een XML-helpbestand voor het script of de functie.

# .EXTERNALHELP <XML Help File>

Het .EXTERNALHELP trefwoord is vereist wanneer een functie of script wordt gedocumenteerd in XML-bestanden. Zonder dit trefwoord kan Get-Help het XML-helpbestand voor de functie of het script niet vinden.

Het .EXTERNALHELP trefwoord heeft voorrang op andere helptrefwoorden op basis van opmerkingen. Als .EXTERNALHELP aanwezig is, geeft Get-Help geen hulp op basis van opmerkingen weer, zelfs niet als er geen Help-onderwerp kan worden gevonden dat overeenkomt met de waarde van het .EXTERNALHELP trefwoord.

Als de functie wordt geëxporteerd door een module, stelt u de waarde van het .EXTERNALHELP trefwoord in op een bestandsnaam zonder pad. Get-Help zoekt naar de opgegeven bestandsnaam in een taalspecifieke submap van de modulemap. Er zijn geen vereisten voor de naam van het XML-helpbestand voor een functie. Vanaf PowerShell 5.0 kunnen functies die door een module worden geëxporteerd, worden gedocumenteerd in een Help-bestand met de naam van de module. U hoeft geen trefwoord voor opmerkingen te gebruiken .EXTERNALHELP . Als de Test-Function functie bijvoorbeeld door de MyModule module wordt geëxporteerd, kunt u het Help-bestand MyModule-help.xmleen naam opgeven. De Get-Help cmdlet zoekt naar help voor de Test-Function functie in het MyModule-help.xml bestand in de modulemap.

Als de functie niet is opgenomen in een module, geef het pad op naar het XML-gebaseerde helpbestand. Als de waarde een pad bevat en het pad ui-cultuurspecifieke submappen bevat, Get-Help zoekt de submappen recursief naar een XML-bestand met de naam van het script of de functie in overeenstemming met de taalvalstandaarden die zijn ingesteld voor Windows, net zoals in een modulemap.

Zie Hoe u cmdlethulp schrijftvoor meer informatie over de XML-gebaseerde helpbestandindeling voor cmdlets.