Skip to content

Instantly share code, notes, and snippets.

@RobsonAutomator

RobsonAutomator/powershell-help.ps1

Created December 27, 2016 19:06
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save RobsonAutomator/aefcd6abb78df97ef28f49529e4a47e0 to your computer and use it in GitHub Desktop.
Save RobsonAutomator/aefcd6abb78df97ef28f49529e4a47e0 to your computer and use it in GitHub Desktop.
Download ZIP
powershell-help
Raw
powershell-help.ps1
<#
.SYNOPSIS
The synopsis goes here. This can be one line, or many.
.DESCRIPTION
The description is usually a longer, more detailed explanation of what the script or function does. Take as many lines as you need.
.PARAMETER computername
Here, the dotted keyword is followed by a single parameter name. Don't precede that with a hyphen. The following lines describe the purpose of the parameter:
.PARAMETER filePath
Provide a PARAMETER section for each parameter that your script or function accepts.
.EXAMPLE
There's no need to number your examples.
.EXAMPLE
PowerShell will number them for you when it displays your help text to a user.
#>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment