Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How to write Powershell help for my cmdlets

I've written my own Powershell cmdlets in c#. How can I add help test, so the I can get a more complete description when users use "Get-Help MYCMDLET"

Thanks,

like image 850
Nestor Avatar asked Jan 07 '10 19:01

Nestor


People also ask

How can you obtain help for PowerShell cmdlets?

The Get-Help cmdlet displays information about PowerShell concepts and commands, including cmdlets, functions, Common Information Model (CIM) commands, workflows, providers, aliases, and scripts. To get help for a PowerShell cmdlet, type Get-Help followed by the cmdlet name, such as: Get-Help Get-Process .

How do you write a help in PowerShell?

The help topic that describes a script or function can be implemented in an XML file that uses the command help schema. To associate the script or function with the XML file, use the ExternalHelp comment keyword followed by the path and name of the XML file.


1 Answers

PowerShell cmdlet help is stored as an XML file. There is some information here. Then there is the Cmdlet Help Editor Tool.

And more recently, the Cmdlet and Help Designer.

like image 87
Joey Avatar answered Oct 18 '22 22:10

Joey