From d99e66110120fc8459bc051cc315e46807f7694f Mon Sep 17 00:00:00 2001
From: Justin Grote <JustinGrote@users.noreply.github.com>
Date: Sat, 29 Jan 2022 10:18:00 -0800
Subject: [PATCH] Add Function-Help Snippet

---
 snippets/PowerShell.json | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/snippets/PowerShell.json b/snippets/PowerShell.json
index 5c1b58e2cc..8355575c9f 100644
--- a/snippets/PowerShell.json
+++ b/snippets/PowerShell.json
@@ -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": [