Powershell: La ayuda basada en comentarios no funciona para scripts que comienzan con un shebang

Creado en 16 nov. 2017  ·  3Comentarios  ·  Fuente: PowerShell/PowerShell

PowerShell no analiza la ayuda basada en comentarios para un script a menos que el comentario de ayuda comience en la primera línea del script. Esto evita que los scripts que emplean un shebang sean útiles a través de Get-Help .

PowerShell debe omitir la primera línea de un archivo de script si comienza con #! .

pasos para reproducir

Cree un nuevo script llamado thing.ps1 con un shebang:

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

Comportamiento esperado

PS> Get-Help thing.ps1

NAME
    /Users/aaron/src/thing.ps1

SYNOPSIS
    This does a thing

…

Comportamiento real

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

Datos ambientales

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

Comentario más útil

Definitivamente es un error. Sin embargo ...

Solo necesita una línea en blanco entre el shebang y la ayuda para solucionarlo.

Todos 3 comentarios

Tenga en cuenta que este es un problema con ambas sintaxis:

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

Definitivamente es un error. Sin embargo ...

Solo necesita una línea en blanco entre el shebang y la ayuda para solucionarlo.

¿Esto se debe a que los intervalos contiguos de comentarios están agrupados, por lo que el sistema de ayuda considera que el tema y la sinopsis son el mismo comentario?

¿Fue útil esta página
0 / 5 - 0 calificaciones

Temas relacionados

rudolfvesely picture rudolfvesely  ·  3Comentarios

alx9r picture alx9r  ·  3Comentarios

andschwa picture andschwa  ·  3Comentarios

HumanEquivalentUnit picture HumanEquivalentUnit  ·  3Comentarios

JohnLBevan picture JohnLBevan  ·  3Comentarios