Lägga till en cmdlet-beskrivning

I det här avsnittet beskrivs hur du lägger till innehåll som visas i avsnittet BESKRIVNING i cmdlet-hjälpen. I hjälpfilen läggs det här innehållet till i noden Kommando för varje cmdlet.

Anteckning

Om du vill ha en fullständig vy över en hjälpfil öppnar du en av dll-Help.xml filerna som finns i PowerShell-installationskatalogen. Filen innehåller till Microsoft.PowerShell.Commands.Management.dll-Help.xml exempel innehåll för flera av PowerShell-cmdletarna.

Lägga till en beskrivning

  • Börja med att förklara de grundläggande funktionerna i cmdleten i detalj. I många fall kan du förklara de termer som används i cmdlet-namnet och illustrera okända begrepp med ett exempel. Om cmdleten till exempel lägger till data i en fil förklarar du att den lägger till data i slutet av en befintlig fil.

  • Om du vill hitta alla funktioner i cmdleten granskar du parameterlistan. Beskriv den primära funktionen för cmdleten och inkludera sedan andra funktioner och funktioner. Om huvudfunktionen i cmdleten till exempel är att ändra en egenskap, men cmdleten kan ändra alla egenskaper, till exempel i den detaljerade beskrivningen. Förklara om cmdletparametrarna låter användarna begära information på olika sätt.

  • Ta med information om hur användare kan använda cmdleten, utöver de uppenbara användningsområdena. Du kan till exempel använda objektet som cmdleten hämtar för att ändra Get-Host textfärgen i Windows PowerShell kommandofönstret.

    Exempel: Get-Acl "Cmdleten hämtar objekt som representerar säkerhetsbeskrivningen för en fil eller resurs. Säkerhetsbeskrivningen innehåller åtkomstkontrollistor (ACL:er) för resursen. ACL:en anger de behörigheter som användare och användargrupper har för att få åtkomst till resursen."

  • Den detaljerade beskrivningen bör beskriva cmdleten, men den bör inte beskriva begrepp som cmdleten använder. Placera konceptdefinitioner i Ytterligare anteckningar.

Se även

Windows PowerShell SDK