Hinweis
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, sich anzumelden oder das Verzeichnis zu wechseln.
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, das Verzeichnis zu wechseln.
In diesem Abschnitt wird beschrieben, wie Sie Inhalte hinzufügen, die im Abschnitt BESCHREIBUNG der Cmdlet-Hilfe angezeigt werden. In der Hilfedatei wird dieser Inhalt dem Knoten Befehl für jedes Cmdlet hinzugefügt.
Hinweis
Um eine vollständige Ansicht einer Hilfedatei zu erhalten, öffnen Sie eine der Dateien im dll-Help.xml PowerShell-Installationsverzeichnis. Die Datei enthält Microsoft.PowerShell.Commands.Management.dll-Help.xml beispielsweise Inhalt für einige der PowerShell-Cmdlets.
So fügen Sie eine Beschreibung hinzu
Beginnen Sie damit, die grundlegenden Features des Cmdlets ausführlicher zu erläutern. In vielen Fällen können Sie die im Cmdlet-Namen verwendeten Begriffe erläutern und unbekannte Konzepte anhand eines Beispiels veranschaulichen. Wenn das Cmdlet beispielsweise Daten an eine Datei anfügt, erläutern Sie, dass es Daten am Ende einer vorhandenen Datei hinzufügt.
Um alle Features des Cmdlets zu finden, überprüfen Sie die Parameterliste. Beschreiben Sie die primäre Funktion des Cmdlets, und schließen Sie dann andere Funktionen und Features ein. Wenn die Hauptfunktion des Cmdlets beispielsweise das Ändern einer Eigenschaft ist, aber das Cmdlet alle Eigenschaften ändern kann, z. B. in der ausführlichen Beschreibung. Wenn die Cmdlet-Parameter benutzern das Abrufen von Informationen auf unterschiedliche Weise ermöglichen, erläutern Sie dies.
Fügen Sie Zusätzlich zu den offensichtlichen Verwendungsmöglichkeiten Informationen zu den Möglichkeiten ein, mit denen Benutzer das Cmdlet verwenden können. Beispielsweise können Sie das -Objekt verwenden, das das Cmdlet abruft, um die Textfarbe im Windows PowerShell
Get-Hoständern.Beispiel: "Das
Get-AclCmdlet ruft Objekte ab, die den Sicherheitsdeskriptor einer Datei oder Ressource darstellen. Die Sicherheitsbeschreibung enthält die Zugriffssteuerungslisten (Access Control Lists, ACLs) der Ressource. Die ACL gibt die Berechtigungen an, die Benutzer und Benutzergruppen für den Zugriff auf die Ressource haben."Die ausführliche Beschreibung sollte das Cmdlet beschreiben, aber keine Konzepte, die das Cmdlet verwendet. Platzieren Sie Konzeptdefinitionen in Zusätzliche Hinweise.