Skip to content

Commit ba742d6

Browse files
JustinGroteandyleejordan
authored andcommitted
Add Function-Help Snippet
1 parent 1f924d1 commit ba742d6

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

snippets/PowerShell.json

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -561,6 +561,25 @@
561561
],
562562
"description": "Comment-based help for an advanced function snippet"
563563
},
564+
"Function-Help": {
565+
"prefix": "help-function",
566+
"body": [
567+
"<#",
568+
".SYNOPSIS",
569+
"\t${1:A short one-line action-based description, e.g. 'Tests if a function is valid'}",
570+
".DESCRIPTION",
571+
"\t${2:A longer description of the function, its purpose, common use cases, etc.}",
572+
".NOTES",
573+
"\t${3:Information or caveats about the function e.g. 'This function is not supported in Linux'}",
574+
".LINK",
575+
"\t${4:Specify a URI to a help page, this will show when Get-Help -Online is used.}",
576+
".EXAMPLE",
577+
"\t${5:Test-MyTestFunction -Verbose}",
578+
"\t${6:Explanation of the function or its result. You can include multiple examples with additional .EXAMPLE lines}",
579+
"#>"
580+
],
581+
"description": "Comment-based help for an advanced function snippet"
582+
},
564583
"Parameter": {
565584
"prefix": "parameter",
566585
"body": [

0 commit comments

Comments
 (0)