Powershell: コメントベースのヘルプは、シバンで始まるスクリプトでは機能しません

作成日 2017年11月16日 · 3コメント · ソース: PowerShell/PowerShell

PowerShellは、ヘルプコメントがスクリプトの最初の行で開始されない限り、スクリプトのコメントベースのヘルプを解析しません。これにより、シバンを使用するスクリプトがGet-Help介して役立つのを防ぎます。

PowerShellは、スクリプトファイルが#!で始まる場合、スクリプトファイルの最初の行をスキップする必要があります。

再現する手順

シバンを使用してthing.ps1という新しいスクリプトを作成します。

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

Issue-Enhancement WG-Interactive-HelpSystem

ソース

abock

👍2

最も参考になるコメント

これは間違いなくバグです。しかし ...

シェバンとそれを回避するためのヘルプの間に空白行が必要です。

Jaykul 2018年03月15日

👍3

全てのコメント3件

これは両方の構文の問題であることに注意してください。

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

abock 2017年11月16日

これは間違いなくバグです。しかし ...

シェバンとそれを回避するためのヘルプの間に空白行が必要です。

Jaykul 2018年03月15日

👍3

これは、連続するコメントのスパンがすべてグループ化されているため、ヘルプシステムがシバンと概要を同じコメントと見なしているためですか？

cspotcode 2018年04月03日

このページは役に立ちましたか？

0 / 5 - 0 評価