PowerShell parst keine kommentarbasierte Hilfe für ein Skript, es sei denn, der Hilfekommentar beginnt in der ersten Zeile des Skripts. Dies verhindert, dass Skripte, die einen Shebang verwenden , über Get-Help
hilfreich sind.
PowerShell sollte die erste Zeile einer Skriptdatei überspringen, wenn sie mit #!
beginnt.
Erstellen Sie ein neues Skript namens thing.ps1
mit einem Shebang:
#!/usr/bin/env pwsh
<#
.SYNOPSIS
This does a thing
#>
PS> Get-Help thing.ps1
NAME
/Users/aaron/src/thing.ps1
SYNOPSIS
This does a thing
…
PS> Get-Help thing.ps1
thing.ps1
…
PS> $PSVersionTable
Name Value
---- -----
PSVersion 6.0.0-beta.9
PSEdition Core
GitCommitId v6.0.0-beta.9
OS Darwin 16.7.0 Darwin Kernel Version 16.7.0: Thu Jun 15 17:36:27 PDT 2017; root:xnu...
Platform Unix
PSCompatibleVersions {1.0, 2.0, 3.0, 4.0...}
PSRemotingProtocolVersion 2.3
SerializationVersion 1.1.0.1
WSManStackVersion 3.0
Beachten Sie, dass dies bei beiden Syntaxen ein Problem ist:
#!/usr/bin/env pwsh
# .SYNOPSIS
# This does a thing
Das ist definitiv ein Bug. Jedoch ...
Sie brauchen nur eine Leerzeile zwischen dem Shebang und der Hilfe, um es zu umgehen.
Liegt das daran, dass zusammenhängende Abschnitte von Kommentaren alle gruppiert sind, sodass das Hilfesystem den Shebang und die Synopse als denselben Kommentar betrachtet?
Hilfreichster Kommentar
Das ist definitiv ein Bug. Jedoch ...
Sie brauchen nur eine Leerzeile zwischen dem Shebang und der Hilfe, um es zu umgehen.