extern/PowerShell
1
0
Fork 0
mirror of https://github.com/fleschutz/PowerShell.git synced 2025-04-02 20:26:56 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update FAQ.md

Browse Source
This commit is contained in:
Markus Fleschutz 2022-09-04 11:38:24 +02:00 committed by GitHub
parent 39258d67c8
commit daf60a7f78
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
Docs/FAQ.md
View File

@ -87,12 +87,12 @@ Good PowerShell scripts are user-friendly and platform-independent. As a guideli
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. Set *execute* file permissions for Linux: `chmod a+rx <filename>` 3. Add a comment-based help at the beginning with synopsis, description, parameters, link, author, and license.
4. 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. 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. Prefer command-line options, else ask the user for help 6. Recommended is `Set-StrictMode -Version Latest` to enable additional error checking.
7. Recommended is `Set-StrictMode -Version Latest` to enable additional error checking. 7. For readibility use UpperCamelCase for variables and functions, lowerCamelCase for everything else.
8. For readibility use UpperCamelCase for variables and functions, lowerCamelCase for everything else. 8. Set *execute* file permissions for Linux: `chmod a+rx <filename>`
9. On success exit with error code 0 (`exit 0`), otherwise print the error with keyword "ERROR:" (to support log parsers) and exit the error code (mostly 1) 9. On success exit with error code 0 (`exit 0`), otherwise print the error with keyword "ERROR:" (to support log parsers) and exit the error code (mostly 1)