2

シナリオの簡単な説明。

New-ModuleCmdLetを使用してオブジェクトを作成しています。このようなもの：

$object = New-Module -Name 'Logger' {
    New-Variable -Name level -Value 200 -Option Constant
    Function log($msg) { Write-Host "$($script:level): $msg" }
    Export-ModuleMember -Variable * -Function *
} -AsCustomObject

$object.log("New user")

関数のオブジェクト定数のコメントベースのヘルプを提供する唯一の方法（私が知っている）であるため、私はその方法を使用してオブジェクトを作成しています。ただし、ScriptBlock またはモジュール全体にコメントを追加してGet-Help $object、ヘルプ テキストを取得したいと考えています。Scriptblock の先頭にコメント ベースのヘルプ テキストを配置してみました。

$object = New-Module -Name 'Logger' {
<#
    Helpful info.
#>
    New-Variable -Name level -Value 200 -Option Constant
    Function log($msg) { Write-Host "$($script:level): $msg" }
    Export-ModuleMember -Variable * -Function *
} -AsCustomObject

オブジェクトを作成しますが、Get-Help で実行すると、Get-Help のヘルプ テキストが表示されるだけです。

これを行うためのより良い方法や、私が見逃しているものはありますか。それともそのような機能はありませんか？

4

1 に答える 1

2

ファイルの作成以外に、モジュールのトップレベルのヘルプはありませんabout_{your-module-name}.txt。PSWorkflow、PSScheduledJob、またはその他のモジュールについてヘルプを取得してみてください。モジュールの about_ トピックがない限り、コマンドを一覧表示するだけです。そのモジュールに対して「Get-Help Pscx 」を実行すると、about_pscx.txt トピックが取得されます。このメカニズムは、関連するモジュール ファイルの隣に about_topic ファイルを配置することで機能します。あなたが作成しているような動的モジュールでそれがどのように機能するかわかりません。

于 2013-11-06T21:13:57.470 に答える