Lägga till cmdlet-namnet och sammanfattningen i ett cmdlet-hjälpavsnitt

  • Artikel

I det här avsnittet beskrivs hur du lägger till innehåll som visas i avsnitten NAME och SYNOPSIS 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 cmdlet-namnet och en sammanfattning

  • Cmdlet-hjälpen kan visa två beskrivningar för cmdleten . Den första beskrivningen är en kort beskrivning som kallas sammanfattning. Den andra beskrivningen är en mer detaljerad beskrivning som beskrivs i Lägga till den detaljerade beskrivningen i ett cmdlet-hjälpavsnitt. Båda dessa beskrivningar ska skrivas som ett stycke.

  • Upprepa inte cmdlet-namnet i sammanfattningen. Att informera användaren om att Get-Server cmdleten hämtar en server är kort, men inte informativt. Använd i stället synonymer och lägg till information i beskrivningen.

    Exempel: "Hämtar ett objekt som representerar en lokal dator eller en fjärrdator."

  • Använd enkla verb som "get", "create" och "change" i sammanfattningen. Undvik att använda "set" eftersom det är vagt och snygga ord som "ändra".

    Exempel: "Hämtar information om Authenticode-signaturen i en fil."

  • Skriva med aktiv röst. Till exempel "Använd TimeSpan-objektet..." är mycket tydligare än "TimeSpan-objektet kan användas för..."

  • Undvik verbet "display" när du beskriver cmdlets som hämtar objekt. Även Windows PowerShell visar cmdlet-data är det viktigt att introducera användare för konceptet att cmdleten returnerar .NET Framework objekt vars data kanske inte visas. Om du framhäver visningen kanske inte användaren inser att cmdleten kan ha returnerat många andra användbara egenskaper och metoder som inte visas.

Se även

Windows PowerShell SDK