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

Update FAQ.md

Browse Source
This commit is contained in:
Markus Fleschutz 2022-05-06 08:59:45 +02:00 committed by GitHub
parent 744ea2275d
commit d32dc93cbb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
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

@ -79,9 +79,9 @@ Good PowerShell scripts are user-friendly and platform-independant. As a guideli
1. the filename is named using the `<verb>-<object>.ps1` scheme 1. the filename is named using the `<verb>-<object>.ps1` scheme
2. the encoding is UTF-8-BOM to provide Unicode character support 2. the encoding is UTF-8-BOM to provide Unicode character support
3. the script has execute file permissions: chmod a+rx <file> (for Linux support) 3. the scripts have execute file permissions: chmod a+rx <file> (for Linux support)
4. the script provides a comment-based help with synopsis, description, parameters, link, author, and license 4. the scripts provide a comment-based help with synopsis, description, parameters, link, author, and license
5. check the requirements (e.g. #Requires -RunAsAdministrator, or #Requires -Version 3) 5. requirements are checked (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
7. recommended is `Set-StrictMode -Version Latest` to enable additional error checking 7. recommended is `Set-StrictMode -Version Latest` to enable additional error checking
8. 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