How do I use .PARAMETER when writing PowerShell help?

Question

How do I use the .PARAMETER option to add detailed information for the parameters of a function when writing the help for it? I tried ".PARAMETER $ParamName", that didn't work, and I tried ".PARAMETER -ParamName", that didn't work either.

Here's an example:

<#

.SYNOPSIS
short overview

.DESCRIPTION

longer overview

.PARAMETER

dont know how this works?

.EXAMPLE

Example code 

.NOTES

This is awesome!

.LINK

http://winfred.com
#>

Anders Zommarin · Accepted Answer · 2011-09-09 16:28:09Z

4

Its not complicated, you simply use it as:

.PARAMETER NameOfParam
    Description of param

For example:

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

answered Sep 9, 2011 at 16:28

Anders Zommarin

7,3142 gold badges27 silver badges25 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

Rynant Over a year ago

Also see: help about_Comment_Based_Help

Torbjörn Bergstedt Over a year ago

A variant (that I prefer) is to put an explanatory comment immediately above the parameter definition. It will then automatically be included as parameter description in the help text.

dthor Over a year ago

And if you want multiple parameters, you'll just add another .PARAMETER MyOtherPara line/block

Collectives™ on Stack Overflow

How do I use .PARAMETER when writing PowerShell help?

1 Answer 1

3 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Your Answer

Sign up or log in

Post as a guest

Related