Powershell: Bantuan berbasis komentar tidak berfungsi untuk skrip yang dimulai dengan shebang

Dibuat pada 16 Nov 2017  ·  3Komentar  ·  Sumber: PowerShell/PowerShell

PowerShell tidak mengurai bantuan berbasis komentar untuk skrip kecuali komentar bantuan dimulai pada baris pertama skrip. Ini mencegah skrip yang menggunakan Shebang agar tidak membantu melalui Get-Help .

PowerShell harus melewati baris pertama file skrip jika dimulai dengan #! .

Langkah-langkah untuk mereproduksi

Buat skrip baru bernama thing.ps1 dengan Shebang:

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

Perilaku yang diharapkan

PS> Get-Help thing.ps1

NAME
    /Users/aaron/src/thing.ps1

SYNOPSIS
    This does a thing

…

Perilaku sebenarnya

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

Data lingkungan

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

Komentar yang paling membantu

Ini pasti bug. Namun ...

Anda hanya perlu garis kosong antara shebang dan bantuan untuk mengatasinya.

Semua 3 komentar

Catatan, ini adalah masalah dengan kedua sintaks:

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

Ini pasti bug. Namun ...

Anda hanya perlu garis kosong antara shebang dan bantuan untuk mengatasinya.

Apakah ini karena rentang komentar yang berdekatan semuanya dikelompokkan bersama, sehingga sistem bantuan menganggap shebang dan sinopsis sebagai komentar yang sama?

Apakah halaman ini membantu?
0 / 5 - 0 peringkat

Masalah terkait

JohnLBevan picture JohnLBevan  ·  3Komentar

rkeithhill picture rkeithhill  ·  3Komentar

rudolfvesely picture rudolfvesely  ·  3Komentar

concentrateddon picture concentrateddon  ·  3Komentar

alx9r picture alx9r  ·  3Komentar