extern/PowerShell
1
0
Fork 0
mirror of https://github.com/fleschutz/PowerShell.git synced 2025-01-31 09:59:17 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'master' of github.com:fleschutz/PowerShell

Browse Source
This commit is contained in:
Markus Fleschutz 2022-11-26 12:05:07 +01:00
commit 863e55138c
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Docs/FAQ.md
View File

@ -93,11 +93,11 @@ Which editor to use for PowerShell scripts?
How to write good PowerShell scripts? How to write good PowerShell scripts?
------------------------------------- -------------------------------------
Good PowerShell scripts are user-friendly and platform-independent. As a guideline follow these rules, please: Good PowerShell scripts are user-friendly and platform-independent. The following rules should be a good starting point:
1. Use the `<verb>-<object>.ps1` scheme to name the script. 1. Use the `<verb>-<object>.ps1` scheme to name the script.
2. Use *UTF-8 BOM* encoding to support Unicode characters in 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`, `.PARAMETER`, `.EXAMPLE`, `.LINK`, and `.NOTES`.
4. Check the requirements for the script, e.g. `#Requires -RunAsAdministrator`, or `#Requires -Version 3` 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 5. Prefer command-line options, else ask the user for help
6. Recommended is `Set-StrictMode -Version Latest` to enable additional error checking. 6. Recommended is `Set-StrictMode -Version Latest` to enable additional error checking.