Как использовать .PARAMETER при написании справки PowerShell?

Question

Как использовать опцию .PARAMETER для добавления подробной информации о параметрах функции при написании справки для нее? Я попробовал ".PARAMETER $ ParamName", который не работал, и я попробовал ".PARAMETER -ParamName", который тоже не работал.

Вот пример:

<#

.SYNOPSIS
short overview

.DESCRIPTION

longer overview

.PARAMETER

dont know how this works?

.EXAMPLE

Example code 

.NOTES

This is awesome!

.LINK

http://winfred.com
#>

Answer 1

Это не сложно, вы просто используете его как:

.PARAMETER NameOfParam
    Description of param

Например:

.PARAMETER MyParam
    MyParam does whatever bla bla bla...