Comment-based help

Comment-based help was introduced with PowerShell 2 and allows the author of a script or function to provide content for Get-Help without needing to understand and work with more complex MAML help files.

PowerShell includes help for authoring comment-based help:

Get-Help about_Comment_Based_Help

Comment-based help uses a series of keywords that match up to the different help sections. The following list shows the most used ones:

• .SYNOPSIS
• .DESCRIPTION
• .PARAMETER <Name>
• .EXAMPLE
• .INPUTS
• .OUTPUTS
• .NOTES
• .LINK

.SYNOPSIS and .DESCRIPTION are mandatory when writing help. Each of the other sections is optional.

.PARAMETER, followed by the name of a parameter, will be included once for each parameter.

.EXAMPLE may be used more than once, describing as many examples as desired.

The tag names are not case-sensitive; uppercase is shown here as it is one of the most widely adopted...