Skip to content

Instantly share code, notes, and snippets.

@dotchetter
Last active November 28, 2019 11:03
Show Gist options
  • Save dotchetter/25722eb0d1a6dd1c82d48cb41487e425 to your computer and use it in GitHub Desktop.
Save dotchetter/25722eb0d1a6dd1c82d48cb41487e425 to your computer and use it in GitHub Desktop.
PowerShell Inline Help Template
<#
.Synopsis
Short Description
.Description
Long Description
.Parameter x
Describe parameter (x)
.Parameter y
Describe parameter (y)
.Parameter z
Describe parameter (z)
.Example
COMMAND EXAMPLE HERE
The first line in this clause will pre-populate with "PS C:\" in runtime.
Give the user an example how to use this module / script by typing a command
in the COMMAND EXAMPLE HERE line and where this text is, explain what it does.
.Example
COMMAND EXAMPLE HERE
The first line in this clause will pre-populate with "PS C:\" in runtime.
Give the user an example how to use this module / script by typing a command
in the COMMAND EXAMPLE HERE line and where this text is, explain what it does.
.Example
COMMAND EXAMPLE HERE
The first line in this clause will pre-populate with "PS C:\" in runtime.
Give the user an example how to use this module / script by typing a command
in the COMMAND EXAMPLE HERE line and where this text is, explain what it does.
.Link
https://domain/yourscript.com
#>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment