Suppose you are writing some PSCmdLet in C#:
/// <summary>
/// Get a stack overflow exception.
/// </summary>
[Cmdlet(VerbsCommon.Join, "StackOverflow")]
[OutputType(typeof(OverflowException))]
public class JoinStackOverflow : PSCmdlet {
protected override void ProcessRecord() {
throw new OverflowException("stack");
}
}
If the module defining the above is loaded into PowerShell, the command help Join-StackOverflow
will return the following:
NAME
Join-StackOverflow
SYNTAX
Join-StackOverflow [<CommonParameters>]
ALIASES
None
REMARKS
None
How can I add a synopsis/summary for this cmdlet, e.g. the same as for Get-Process
:
NAME
Get-Process
SYNOPSIS
Gets the processes that are running on the local computer or a remote computer.
...