Freigeben über

Ablegen der kommentarbasierten Hilfe in Skripts

  • Artikel

In diesem Thema wird erläutert, wo kommentarbasierte Hilfe für ein Skript platziert werden soll, damit das cmdlet Get-Help das kommentarbasierte Hilfethema Skripts zuordnet und nicht mit Funktionen, die sich möglicherweise im Skript befinden.

Speicherort für Comment-Based Hilfe für ein Skript

  • Am Anfang der Skriptdatei.

    Der Skripthilfe kann im Skript nur Kommentare und Leerzeilen vorangestellt werden.

  • Am Ende der Skriptdatei.

    Wenn das erste Element im Skripttext (nach der Hilfe) eine Funktionsdeklaration ist, müssen mindestens zwei leere Zeilen zwischen dem Ende der Skripthilfe und der Funktionsdeklaration vorhanden sein. Andernfalls wird die Hilfe als Hilfe für die Funktion interpretiert, nicht als Hilfe für das Skript.

Beispiele für die Platzierung von Hilfen in einem Skript

Die folgenden Beispiele zeigen die einzelnen Platzierungsoptionen für die kommentarbasierte Hilfe für ein Skript.

Hilfe am Anfang eines Skripts

Das folgende Beispiel zeigt kommentarbasiert am Anfang eines Skripts.

<#
.DESCRIPTION
This script performs a series of network connection tests.
#>

param [string]$ComputerName
...

Hilfe am Ende eines Skripts

Das folgende Beispiel zeigt am Ende eines Skripts kommentarbasiert.

...
function Ping { Test-Connection -ComputerName $ComputerName }

<#
.DESCRIPTION
This script performs a series of network connection tests.
#>