From d64c803dd0940ec2e26f37982d4bd8b4ba0c2491 Mon Sep 17 00:00:00 2001 From: Markus Fleschutz Date: Sat, 26 Nov 2022 09:59:24 +0100 Subject: [PATCH] Update FAQ.md --- Docs/FAQ.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Docs/FAQ.md b/Docs/FAQ.md index 5ae1ed15..f9759cf8 100644 --- a/Docs/FAQ.md +++ b/Docs/FAQ.md @@ -96,8 +96,8 @@ How to write good PowerShell scripts? Good PowerShell scripts are user-friendly and platform-independent. As a guideline follow these rules, please: 1. Use the `-.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`. +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`, `.PARAMETER`, `.EXAMPLE`, `.LINK`, and `.NOTES`. 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.