Powershell: L'aide basée sur les commentaires ne fonctionne pas pour les scripts qui commencent par un shebang

Créé le 16 nov. 2017  ·  3Commentaires  ·  Source: PowerShell/PowerShell

PowerShell n'analyse pas l'aide basée sur les commentaires pour un script à moins que le commentaire d'aide ne commence sur la première ligne du script. Cela empêche les scripts utilisant un shebang d'être utiles via Get-Help .

PowerShell doit ignorer la première ligne d'un fichier de script s'il commence par #! .

Étapes à reproduire

Créez un nouveau script appelé thing.ps1 avec un shebang :

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

Comportement prévisible

PS> Get-Help thing.ps1

NAME
    /Users/aaron/src/thing.ps1

SYNOPSIS
    This does a thing

…

Comportement réel

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

Données environnementales

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

Commentaire le plus utile

C'est certainement un bug. Toutefois ...

Vous avez juste besoin d'une ligne blanche entre le shebang et l'aide pour le contourner.

Tous les 3 commentaires

Notez qu'il s'agit d'un problème avec les deux syntaxes :

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

C'est certainement un bug. Toutefois ...

Vous avez juste besoin d'une ligne blanche entre le shebang et l'aide pour le contourner.

Est-ce parce que les plages de commentaires contiguës sont toutes regroupées, de sorte que le système d'aide considère que le shebang et le synopsis sont le même commentaire ?

Cette page vous a été utile?
0 / 5 - 0 notes