Trefwoorden voor Help op basis van opmerkingen

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

Trefwoorden in Comment-Based Help

Hier volgen geldige Help-trefwoorden op basis van opmerkingen. Ze worden vermeld in de volgorde waarin ze doorgaans worden weergegeven in een Help-onderwerp, samen met hun beoogde gebruik. Deze trefwoorden kunnen in elke volgorde worden weergegeven in de Help op basis van opmerkingen en ze zijn niet gevoelig voor opmerkingen.

Houd er rekening mee dat .EXTERNALHELP het trefwoord voorrang heeft op alle andere Help-trefwoorden op basis van opmerkingen. Wanneer .EXTERNALHELP aanwezig is, geeft de cmdlet Get-Help geen help 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 één keer in elk onderwerp worden gebruikt.

.DESCRIPTION

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

.PARAMETER <Parameter-Name>

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

De .PARAMETER trefwoorden kunnen in elke volgorde worden weergegeven in het opmerkingenblok, maar de volgorde waarin de parameters worden weergegeven in Param de instructie 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 Param de instructie of functiedeclaratie.

U kunt ook een parameterbeschrijving opgeven door een opmerking in Param de instructie direct vóór de naam van de parametervariabele te plaatsen. Als u zowel een opmerking bij een Param instructie .PARAMETER als een trefwoord gebruikt, .PARAMETER wordt de beschrijving die is gekoppeld aan het trefwoord gebruikt en Param wordt de opmerking van de 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

Microsoft .NET Framework typen objecten die kunnen worden doorspijpt naar de functie of het script. U kunt ook een beschrijving van de invoerobjecten opnemen.

.OUTPUTS

Het .NET Framework van de objecten die de cmdlet retourneert. U kunt ook een beschrijving van de geretourneerde objecten opnemen.

.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 Gerelateerde koppelingen van het Help-onderwerp.

De .LINK inhoud van het trefwoord kan ook een Uniform Resource Identifier (URI) bevatten voor een onlineversie van hetzelfde Help-onderwerp. De onlineversie wordt geopend wanneer u de Online parameter van gebruikt Get-Help. 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 Component parameter van gebruikt Get-Help deze waarde om de zoekresultaten te filteren die worden geretourneerd door Get-Help.

.ROLE

De naam van de gebruikersrol voor het Help-onderwerp. De Role parameter van gebruikt Get-Help 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 Functionality parameter van gebruikt Get-Help 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-onderwerpen voor een functie, script, cmdlet of provider.

.FORWARDHELPCATEGORY <Category>

Hiermee geeft u de Help-categorie van het item in op .FORWARDHELPTARGETNAME. Gebruik dit trefwoord om conflicten te voorkomen wanneer er opdrachten met dezelfde naam zijn.

Geldige waarden zijn:

• Alias
• Cmdlet
• Helpfile
• Function
• Provider
• General
• FAQ
• Glossary
• ScriptCommand
• ExternalScript
• Filter
• Alles

.REMOTEHELPRUNSPACE <PSSession-variable>

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

.EXTERNALHELP <XML Help File>

Hiermee geeft u het pad en/of de naam op van een Help-bestand op basis van XML voor het script of de functie.

Het .EXTERNALHELP trefwoord vertelt de cmdlet Get-Help om hulp te krijgen voor het script of de functie in een XML-bestand. Het .EXTERNALHELP trefwoord is vereist wanneer u een helpbestand op basis van XML gebruikt voor een script of functie. Zonder deze functie vindt Get-Help geen helpbestand voor de functie of het script.

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

Wanneer de functie wordt geëxporteerd door een scriptmodule, moet de waarde van .EXTERNALHELP een bestandsnaam zonder pad zijn. Get-Help zoekt naar het bestand in een submap die specifiek is voor de lokale omgeving van de modulemap. Er zijn geen vereisten voor de bestandsnaam, maar een best practice is om de volgende bestandsnaamindeling te gebruiken: <ScriptModule>.psm1-help.xml.

Wanneer de functie niet is gekoppeld aan een module, moet u een pad en bestandsnaam opnemen in de waarde van het trefwoord .EXTERNALHELP . Als het opgegeven pad naar het XML-bestand UI-cultuurspecifieke submaieën bevat, Get-Help zoekt recursief naar een XML-bestand met de naam van het script of de functie in overeenstemming met de taalterugvalstandaarden die zijn vastgelegd voor Windows, net als voor alle Help-onderwerpen op basis van XML.

Zie Writing Windows PowerShell Cmdlet Help voor meer informatie over de Help-bestandsindeling help-xml-cmdlet.