O PowerShell não analisa a ajuda baseada em comentários para um script, a menos que o comentário de ajuda comece na primeira linha do script. Isso evita que os scripts que empregam um shebang sejam úteis por meio de Get-Help
.
O PowerShell deve pular a primeira linha de um arquivo de script se ele começar com #!
.
Crie um novo script chamado thing.ps1
com um 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
Observe que este é um problema com as duas sintaxes:
#!/usr/bin/env pwsh
# .SYNOPSIS
# This does a thing
Este é definitivamente um bug. Contudo ...
Você só precisa de uma linha em branco entre o shebang e a ajuda para contorná-lo.
Isso ocorre porque as extensões contíguas de comentários são agrupadas, de modo que o sistema de ajuda considera o conteúdo e a sinopse como o mesmo comentário?
Comentários muito úteis
Este é definitivamente um bug. Contudo ...
Você só precisa de uma linha em branco entre o shebang e a ajuda para contorná-lo.