- 2016/09/12
- 2分で読める
-
- j
- s
- n
このセクションでは、コメントベースのヘルプの構文について説明します。ベースのヘルプの構文について説明します。
構文図
コメントベースのヘルプの構文は次のとおりです:
# .< help keyword># <help content>-or -<#.< help keyword>< help content>#>
構文の説明
コメントベースのヘルプは、一連のコメントとして書かれています。 コメントの各行の前にコメント記号(#
<#
#>
の記号を使ってコメントブロックを作ることができます。
コメントベースのヘルプの各セクションはキーワードで定義され、各キーワードの前にはドット(.
)が付けられます。 キーワードはどのような順序でも使用できます。
コメントブロックには、少なくとも1つのヘルプキーワードを含める必要があります。
コメント・ブロックには、少なくとも1つのヘルプ・キーワードを含める必要があります。
コメントベースのヘルプトピックでは、すべての行が連続していなければなりません。 コメントベースのヘルプトピックが、ヘルプトピックの一部ではないコメントに続く場合、ヘルプではないコメントの最後の行と、コメントベースのヘルプの始まりの間には、少なくとも1つの空白行が必要です。