Created
May 24, 2019 03:40
-
-
Save Jaykul/b8ca9ea9192b1e45c91e9e7efde1b321 to your computer and use it in GitHub Desktop.
Just an example of authoring help with parameter help in-line
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | |
) | |
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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