Powershell: A ajuda baseada em comentários não funciona para scripts que começam com um shebang

Criado em 16 nov. 2017  ·  3Comentários  ·  Fonte: PowerShell/PowerShell

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 #! .

Passos para reproduzir

Crie um novo script chamado thing.ps1 com um shebang:

#!/usr/bin/env pwsh
<#
.SYNOPSIS
This does a thing
#>

Comportamento esperado

PS> Get-Help thing.ps1

NAME
    /Users/aaron/src/thing.ps1

SYNOPSIS
    This does a thing

…

Comportamento real

PS> Get-Help thing.ps1
thing.ps1
…

Dados ambientais

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
Issue-Enhancement WG-Interactive-HelpSystem

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.

Todos 3 comentários

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?

Esta página foi útil?
0 / 5 - 0 avaliações

Questões relacionadas

alx9r picture alx9r  ·  3Comentários

JohnLBevan picture JohnLBevan  ·  3Comentários

manofspirit picture manofspirit  ·  3Comentários

rkeithhill picture rkeithhill  ·  3Comentários

pcgeek86 picture pcgeek86  ·  3Comentários