Update FAQ.md

This commit is contained in:
Markus Fleschutz 2022-09-04 11:31:39 +02:00 committed by GitHub
parent 1cb3ca6731
commit 9cec25554c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -87,7 +87,7 @@ 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 <file> 3. Set *execute* file permissions for Linux: `chmod a+rx <filename>`
4. 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.
5. 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`
6. Prefer command-line options, else ask the user for help 6. Prefer command-line options, else ask the user for help