powershell - 编写 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...