Help-onderwerpen op basis van opmerkingen schrijven

U kunt Help-onderwerpen op basis van opmerkingen voor functies en scripts schrijven met behulp van speciale Trefwoorden voor Help-opmerkingen.

De cmdlet geeft help op basis van opmerkingen weer in dezelfde indeling waarin de Help-onderwerpen voor cmdlet worden weergegeven Get-Help die zijn gegenereerd op basis van XML-bestanden. Gebruikers kunnen alle parameters van gebruiken, zoals Gedetailleerd, Volledig, Voorbeeld en Online, om de Help Get-Help voor functies en scripts weer te geven.

U kunt ook Help-onderwerpen op basis van XML voor scripts en functies schrijven en de trefwoorden voor Help-opmerkingen gebruiken om gebruikers om te leiden naar de op XML gebaseerde onderwerpen of andere onderwerpen.

In deze sectie

Syntaxis van Comment-Based Help Beschrijft de syntaxis van help op basis van opmerkingen.

Op opmerkingen gebaseerde Help-trefwoorden Een lijst met de trefwoorden in help op basis van opmerkingen.

Help Comment-Based functies plaatsen Toont waar u help op basis van opmerkingen voor een functie kunt plaatsen.

Help Comment-Based plaatsen in scripts Toont waar u help op basis van opmerkingen voor een script kunt plaatsen.