Navigation Menu

Skip to content

Instantly share code, notes, and snippets.

@Jaykul
Created May 24, 2019 03:40
Show Gist options
  • Star 2 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save Jaykul/b8ca9ea9192b1e45c91e9e7efde1b321 to your computer and use it in GitHub Desktop.
Save Jaykul/b8ca9ea9192b1e45c91e9e7efde1b321 to your computer and use it in GitHub Desktop.
Just an example of authoring help with parameter help in-line
function Test-Help {
<#
.SYNOPSIS
Test the help
.EXAMPLE
Get-Help Test-Help
Shows the help for this function, which is all this function is good for
#>
[CmdletBinding()]
param(
# This is where you would describe the name
$Name
)
}
NAME
Test-Help
SYNOPSIS
Test the help
SYNTAX
Test-Help [[-Name] <Object>] [<CommonParameters>]
DESCRIPTION
PARAMETERS
-Name <Object>
This is where you would describe the name
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
-------------------------- EXAMPLE 1 --------------------------
PS > Get-Help Test-Help
Shows the help for this function, which is all this function is good for
RELATED LINKS
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment