Question

I have the following simple script that accepts text as input and writes it to the host.

<#
.SYNOPSIS
    Writes the input string to the host.
.PARAMETER Text
    The text to write to the host.
#>

param([string]$text = "hello world!")
Write-Host $text

To render the help for this script, I execute the following command within a Powershell session, where write-text.ps1 is the name of this script.

get-help .\write-text.ps1 -full

In the following output, I am expecting to see the default value of the script’s parameter listed in the help — but I don’t:

PARAMETERS
    -text <String>
        The text to write to the host.

        Required?                    false
        Position?                    1
        Default value
        Accept pipeline input?       false
        Accept wildcard characters?

What do I need to add or change in this script for the help-engine to render the default parameter value?

Answer 1

You can not show a default value using the comment based help. You need to make a MAML help file to do that.