Skip to content

Add Function Help Snippet #3799

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Add Function Help Snippet #3799

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions snippets/PowerShell.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -561,6 +561,25 @@
],
"description": "Comment-based help for an advanced function snippet"
},
"Function-Help": {
"prefix": "help-function",
"body": [
"<#",
".SYNOPSIS",
"\t${1:A short one-line action-based description, e.g. 'Tests if a function is valid'}",
".DESCRIPTION",
"\t${2:A longer description of the function, its purpose, common use cases, etc.}",
".NOTES",
"\t${3:Information or caveats about the function e.g. 'This function is not supported in Linux'}",
".LINK",
"\t${4:Specify a URI to a help page, this will show when Get-Help -Online is used.}",
".EXAMPLE",
"\t${5:Test-MyTestFunction -Verbose}",
"\t${6:Explanation of the function or its result. You can include multiple examples with additional .EXAMPLE lines}",
"#>"
],
"description": "Comment-based help for an advanced function snippet"
},
"Parameter": {
"prefix": "parameter",
"body": [
Expand Down