Feedback

Een cmdlet-beschrijving toevoegen

  • Artikel
  • 2 minuten om te lezen

In deze sectie wordt beschreven hoe u inhoud toevoegt die wordt weergegeven in de sectie BESCHRIJVING van de Help van de cmdlet. In het Help-bestand wordt deze inhoud toegevoegd aan het knooppunt Opdracht voor elke cmdlet.

Notitie

Voor een volledige weergave van een Help-bestand opent u een van de dll-Help.xml bestanden in de PowerShell-installatiemap. Het bestand bevat Microsoft.PowerShell.Commands.Management.dll-Help.xml bijvoorbeeld inhoud voor verschillende PowerShell-cmdlets.

Een beschrijving toevoegen

  • Begin door de basisfuncties van de cmdlet gedetailleerder uit te leggen. In veel gevallen kunt u de termen uitleggen die worden gebruikt in de cmdlet-naam en onbekende concepten illustreren met een voorbeeld. Als de cmdlet bijvoorbeeld gegevens toevoegt aan een bestand, legt u uit dat deze gegevens toevoegt aan het einde van een bestaand bestand.

  • Als u alle functies van de cmdlet wilt vinden, bekijkt u de lijst met parameters. Beschrijf de primaire functie van de cmdlet en neem vervolgens andere functies en functies op. Als de hoofdfunctie van de cmdlet bijvoorbeeld is om één eigenschap te wijzigen, maar de cmdlet alle eigenschappen kan wijzigen, bijvoorbeeld in de gedetailleerde beschrijving. Als de cmdlet-parameters de gebruikers op verschillende manieren om informatie laten vragen, leg het dan uit.

  • Neem informatie op over de manieren waarop gebruikers de cmdlet kunnen gebruiken, naast de voor de hand liggende toepassingen. U kunt bijvoorbeeld het object gebruiken dat de cmdlet op haalt om de kleur van de tekst in het Windows PowerShell Get-Host wijzigen.

    Voorbeeld: De Get-Acl cmdlet haalt objecten op die de security descriptor van een bestand of resource vertegenwoordigen. De security descriptor bevat de toegangsbeheerlijsten (ACL's) van de resource. De ACL geeft de machtigingen aan die gebruikers en gebruikersgroepen hebben voor toegang tot de resource.

  • In de gedetailleerde beschrijving moet de cmdlet worden beschreven, maar er moeten geen concepten worden beschreven die door de cmdlet worden gebruikt. Plaats conceptdefinities in Aanvullende opmerkingen.

Zie ook

Windows PowerShell SDK