Partager via

<description> Element (Windows Script Host)

  • Article

Marks the descriptive text that is displayed when the ShowUsage method is executed or when the script is run with the /? command line switch.

                      <description> 
    This section describes the script
</description>

Remarks

Your description can be more than one line long.

Do not include quotes in your description if you do not want them to appear in the usage. All text between the description tags appears in the usage listing. This includes, among others, tabs, new lines, and special characters.

The <description> element is similar to the <example> element, except it appears at the start of the usage, whereas the <example> element appears at the end.

Example

The following script demonstrates the use of the <description> Element:

<runtime>
    <description>
        This script reboots a server
    </description>
    <!--...etc...-->
</runtime>

See Also

Reference

ShowUsage Method

<runtime> Element (Windows Script Host)

<named> Element

<unnamed> Element

<example> Element