How do I get help messages to appear for my Powershell script parameters?

Question

I have a powershell script (setup.ps1), that we use as the entry point for our development environment setup scripts. It takes a parameter:

par         


        

Answer 1

one just needs the <# .SYNOPSIS #> part on top of the file to make it work and you can comment your params nicely inline:

<# .SYNOPSIS #>
param(
   [String]$foo   ## my 1st cool param
  ,[Switch]$bar  ## my 2nd crazy switch
)
...

(checked with PS 5.1.14409.1018)