编写PowerShell帮助时如何使用.PARAMETER？

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...