<description> 要素

  • [アーティクル]

ShowUsage メソッドを実行するか、または /? コマンド ライン スイッチ付きでスクリプトを実行したときに表示される説明テキストを表します。

<description>
    スクリプトの説明テキスト
</description>

解説

説明テキストは、複数行にできます。

Usage (使用法)を表示するときに引用符を表示したくない場合は、説明に引用符を含めないでください。description タグの間のテキストは、Usage (使用法)の画面表示に含まれます。これには、タブや改行などの特殊文字も含まれます。

<description> 要素は <example> 要素に似ていますが、<example> 要素が Usage の末尾に表示されるのに対し、<description> 要素は Usage の先頭に表示されます。

使用例

ここでは、<description> 要素を使ったスクリプトのサンプルを示します。

<runtime>
    <description>
        このスクリプトは、サーバーを再起動します。
    </description>
    <!--...etc...-->
</runtime>

参照

ShowUsage メソッド | <runtime> 要素 | <named> 要素 | <unnamed> 要素 | <example> 要素