他のCmdLetsをPowerShellのマニュアルで参照してください

Question

モジュールに含まれているPowerShell CmdLet ps1スクリプト にコメントベースのヘルプを書き込むと、同じモジュール内の他の CmdLetsを参照することができます。結果としてユーザーに出力されます 接頭辞とインポートされたときに参照されるCmdLetの名前が出力されますか？

だから私はこのように私のコメントベースのヘルプ書く場合、たとえば、：

function Get-Thing { 
<# 

.SYNOPSIS 

Get the thing. 

.DESCRIPTION 

The Get-Thing CmdLet will get a thing. 

#> 
[CmdletBinding()] 
Param(...) 

を、ユーザーが接頭辞を使用してモジュールをインポート：

Import-Module -Prefix My 

それから私は助けを印刷します説明フィールドのGet-ThingをGet-MyThingとして、ユーザーが提供したモジュールプレフィックス値を参考にしてください。

> help Get-MyThing 

NAME 
    ... 

SYNOPSIS 
    ... 

SYNTAX 
    ... 

DESCRIPTION 
    This Get-MyThing CmdLet will get a thing. 

これは可能ですか？

Answer 1

セクションを使用すると、プレフィックスを含むようにセクションが自動的に更新されます。コメントに変数を埋め込むことができないため、ヘルプテキストの他の場所で使用すると変更できません。

ほとんどの場合、例で使用したいが、変更されないコマンドレット名を使用することは避けてください。しかし、少なくともNAMEセクションとSYNTAXセクションは正確で、ユーザーが自己修正するのに役立ちます。

PowerShellを使用してファイルを読み込んで編集する際にモジュールが読み込まれるため、コメントに外部のヘルプファイルやプレースホルダーが書き込まれることが考えられますが、 tは価値があるようです。