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

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

構文図

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

# .< help keyword>
# <help content>

または

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

構文の説明

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

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

コメント ブロックには、少なくとも 1 つのヘルプ キーワードが含まれている必要があります。 .EXAMPLEなどの一部のキーワードは、同じコメント ブロックに何度も表示される場合があります。 各キーワードのヘルプ コンテンツは、キーワードの後の行から始まり、複数の行にまたがることができます。

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

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

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