WinPS/Function

Windows PowerShell

PowerShell 関数

コメントベース ヘルプ

スクリプトに、コメント内にヘルプキーワードと本文を記載することで、Get-Help 用のヘルプが書ける。ヘルプを記載する位置は、関数内の先頭か末端、もしくは、関数の宣言の直前 に記載する

ただし、通常（スクリプト内で記載すると）関数のスコープがスクリプト内となるため、ヘルプの同様にスクリプト内でしか使えない。そのため、コンソールなどで使用する場合は、関数宣言時に global: 修飾子をつけて関数をグローバルスコープで宣言する必要がある。

• Writing Comment-Based Help Topics - PowerShell | Microsoft Learn
  • https://learn.microsoft.com/ja-jp/powershell/scripting/developer/help/writing-comment-based-help-topics

  ヘルプキーワード

.SYNOPSIS

関数またはスクリプトの簡単な説明。

.DESCRIPTION

関数またはスクリプトの詳細な説明。

.PARAMETER <Parameter-Name>

パラメータの説明。

.EXAMPLE

関数またはスクリプトを使用するサンプル コマンド。例ごとにこのキーワードを繰り返します。

.NOTES

関数またはスクリプトに関する追加情報。

 例

<#
    .Description
    The MyProcess function gets the Windows PowerShell process.
#>
function MyFunction { Get-Process powershell}