extern/PowerShell
1
0
Fork 0
mirror of https://github.com/fleschutz/PowerShell.git synced 2025-03-21 02:37:35 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update FAQ.md

Browse Source
This commit is contained in:
Markus Fleschutz 2022-11-26 09:56:49 +01:00 committed by GitHub
parent c3b3b492d4
commit 2ecd726f43
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Docs/FAQ.md
View File

@ -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.