コメント ベースのヘルプの構文

ここでは、コメントベースのヘルプの構文について説明します。

構文ダイアグラム

コメントベースのヘルプの構文は次のとおりです。

# .< help keyword>
# <help content>

-or -

<#
.< help keyword>
< help content>
#>

構文の説明

コメントベースのヘルプは、一連のコメントとして書かれています。 コメントの各行の前にコメント記号 () を入力する # か、および記号を使用し <# てコメントブロックを作成することができ #> ます。 コメントブロック内のすべての行は、コメントとして解釈されます。

コメントベースのヘルプの各セクションは、キーワードによって定義され、各キーワードの前にドット () が付き . ます。 キーワードは任意の順序で表示できます。 キーワード名の大文字と小文字は区別されません。

コメントブロックには、少なくとも1つのヘルプキーワードを含める必要があります。 たとえば、いくつかのキーワードは、同じコメントブロック内で何度も出現する可能性があります。 各キーワードのヘルプコンテンツは、キーワードの後の行から開始され、複数の行にまたがることができます。

コメントベースのヘルプトピック内のすべての行は、連続している必要があります。 コメントベースのヘルプトピックがヘルプトピックに含まれていないコメントの後に続く場合は、ヘルプ以外の最後のコメント行とコメントベースのヘルプの先頭の間に、少なくとも1つの空白行がある必要があります。

たとえば、次のコメントベースのヘルプトピックにはが含まれています。Description キーワードとその値 (関数またはスクリプトの説明)。

<#
    .Description
    The Get-Function function displays the name and syntax of all functions in the session.
#>