From 2ecd726f435836e974a014d77eafaf71b1f3ebc7 Mon Sep 17 00:00:00 2001 From: Markus Fleschutz <markus@fleschutz.de> Date: Sat, 26 Nov 2022 09:56:49 +0100 Subject: [PATCH] Update FAQ.md --- Docs/FAQ.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Docs/FAQ.md b/Docs/FAQ.md index 3af00ea8..5ae1ed15 100644 --- a/Docs/FAQ.md +++ b/Docs/FAQ.md @@ -97,7 +97,7 @@ Good PowerShell scripts are user-friendly and platform-independent. As a guideli 1. Use the `<verb>-<object>.ps1` scheme to name the script. 2. Use *UTF-8 BOM* encoding to support Unicode characters in the script. -3. Add a comment-based help at the beginning with synopsis, description, parameters, link, author, and license. +3. Add a comment-based help at the beginning with: `synopsis`, `description`, `parameters`, `link`, `author`, and `license`. 4. Check the requirements for the script, e.g. `#Requires -RunAsAdministrator`, or `#Requires -Version 3` 5. Prefer command-line options, else ask the user for help 6. Recommended is `Set-StrictMode -Version Latest` to enable additional error checking.