Skip to content

Instantly share code, notes, and snippets.

@jkavanagh58
Created October 1, 2019 15:15
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save jkavanagh58/5bcc9b2b49608025354f79bfac34d3f1 to your computer and use it in GitHub Desktop.
Save jkavanagh58/5bcc9b2b49608025354f79bfac34d3f1 to your computer and use it in GitHub Desktop.
VSCode Snippet - PowerShell CBH for Functions
"Function CBH": {
"prefix": "PSFuncHelp",
"body": [
"<#\r",
".SYNOPSIS\r",
"\tShort description",
".DESCRIPTION\r",
"\tLong description",
".PARAMETER Path\r",
"\tSpecifies a path to one or more locations.",
".PARAMETER LiteralPath",
"\tSpecifies a path to one or more locations. Unlike Path, the value of LiteralPath is used exactly as it",
"\tis typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose",
"\tit in single quotation marks. Single quotation marks tell Windows PowerShell not to interpret any",
"\tcharacters as escape sequences.",
".PARAMETER InputObject\r",
"\tSpecifies the object to be processed. You can also pipe the objects to this command.",
".EXAMPLE\r",
"\tPS>_ \r",
"\tExample of how to use this cmdlet",
".EXAMPLE\r",
"\tPS>_ \r",
"\tAnother example of how to use this script.\r",
".INPUTS\r",
"\tInputs to this cmdlet (if any)\r",
".OUTPUTS\r",
"\tOutput from this cmdlet (if any)\r",
".NOTES\r",
"\t===========================================================================\r",
"\tCreated with:\tVisual Studio Code\r",
"\tCreated on:\t\t$CURRENT_MONTH.$CURRENT_DATE.$CURRENT_YEAR\r",
"\tCreated by:\t\t${1:Developer}\r",
"\tOrganization:\t${2:Organization}\r",
"\tFunction Name:\t${3:FunctionName}\r",
"\t===========================================================================\r",
"\t$date $initials: Enter first comment here\r",
"#>\r"
],
"description": "Help comment block - Functions"
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment