PowerShell Help Tags and Meanings
<#
.SYNOPSIS
<!--
A very brief description of the function.
It begins with a verb and tells the user what the function does.
It does not include the function name or how the function works.
The function synopsis appears in the SYNOPSIS field of all help views.
-->
.DESCRIPTION
<!--
Two or three full sentences that briefly list everything that the function can do.
The description begins with "The <function name> function…."
If the function can get multiple objects or take multiple inputs, use plural nouns in the description.
The description appears in the DESCRIPTION field of all Help views.
-->
.PARAMETER
<!--
Brief and thorough.
Describe what the function does when the parameter is used.
And what legal values are for the parameter.
The parameter appears in the PARAMETERS field only in Detailed and Full Help views.
-->
.EXAMPLE
<!--
Illustrate use of function with all its parameters.
First example is simplest with only the required parameters.
Last example is most complex and should incorporate pipelining if appropriate.
The example appears only in the EXAMPLES field in the Example, Detailed, and Full Help views.
-->
.NOTES
<!--
Provides a place to list information that does not fit easily into the other sections.
This can be special requirements required by the function, as well as author, title, version, and other information.
The notes Help tag appear in the NOTES field only in the Full help view.
-->
#>
<#
<!--
The minimum is to use .SYNOPSIS, .DESCRIPTION, .PARAMETER (if there is) and .EXAMPLE
-->
.SYNOPSIS
<!--
A very brief description of the function.
It begins with a verb and tells the user what the function does.
It does not include the function name or how the function works.
The function synopsis appears in the SYNOPSIS field of all help views.
-->
.DESCRIPTION
<!--
Two or three full sentences that briefly list everything that the function can do.
The description begins with "The <function name> function…."
If the function can get multiple objects or take multiple inputs, use plural nouns in the description.
The description appears in the DESCRIPTION field of all Help views.
-->
.PARAMETER [PARAMETER_NAME]
<!--
Brief and thorough.
Describe what the function does when the parameter is used.
And what legal values are for the parameter.
The parameter appears in the PARAMETERS field only in Detailed and Full Help views.
-->
.EXAMPLE
[SCRIPT_NAME | FUNCTION_NAME]
[DESCRIPTION]
<!--
Illustrate use of function with all its parameters.
First example is simplest with only the required parameters.
Last example is most complex and should incorporate pipelining if appropriate.
The example appears only in the EXAMPLES field in the Example, Detailed, and Full Help views.
-->
.INPUTS
<!--
Lists the .NET Framework classes of objects the function will accept as input.
There is no limit to the number of input classes you may list.
The inputs Help tag appears only in the INPUTS field in the Full Help view.
-->
.OUTPUTS
<!--
Lists the .NET Framework classes of objects the function will emit as output.
There is no limit to the number of output classes you may list.
The outputs Help tag appears in the OUTPUTS field only in the Full Help view.
-->
.NOTES
<!--
Provides a place to list information that does not fit easily into the other sections.
This can be special requirements required by the function, as well as author, title, version, and other information.
The notes Help tag appear in the NOTES field only in the Full help view.
-->
.LINK
<!--
Provides links to other Help topics and Internet Web sites of interest.
Because these links appear in a command window, they are not direct links.
There is no limit to the number of links you may provide.
The links appear in the RELATED LINKS field in all Help views.
-->
.COMPONENT
<!--
The technology or feature that the function or script uses, or to which
it is related. This content appears when the Get-Help command includes
the Component parameter of Get-Help.
-->
.ROLE
<!--
The user role for the Help topic. This content appears when the Get-Help
command includes the Role parameter of Get-Help.
-->
.FUNCTIONALITY
<!--
The intended use of the function. This content appears when the Get-Help
command includes the Functionality parameter of Get-Help.
-->
.FORWARDHELPTARGETNAME <Command-Name>
<!--
Redirects to the Help topic for the specified command. You can redirect
users to any Help topic, including Help topics for a function, script,
cmdlet, or provider.
-->
.FORWARDHELPCATEGORY <Category>
<!--
Specifies the Help category of the item in ForwardHelpTargetName.
Valid values are Alias, Cmdlet, HelpFile, Function, Provider, General,
FAQ, Glossary, ScriptCommand, ExternalScript, Filter, or All. Use this
keyword to avoid conflicts when there are commands with the same name.
-->
.REMOTEHELPRUNSPACE <PSSession-variable>
<!--
Specifies a session that contains the Help topic. Enter a variable that
contains a PSSession. This keyword is used by the Export-PSSession
cmdlet to find the Help topics for the exported commands.
-->
.EXTERNALHELP <XML Help File Path>
<!--
Specifies the path to an XML-based Help file for the script or function.
In Windows Vista and later versions of Windows, if the specified path
to the XML file contains UI-culture-specific subdirectories, Get-Help
searches the subdirectories recursively for an XML file with the name
of the script or function in accordance with the language fallback
standards established for Windows Vista, just as it does for all
XML-based Help topics.
For more information about the cmdlet Help XML-based Help file format,
see "How to Create Cmdlet Help" in the MSDN (Microsoft Developer Network)
library at http://go.microsoft.com/fwlink/?LinkID=123415.
-->
#>