extern/PowerShell
1
0
Fork 0
mirror of https://github.com/fleschutz/PowerShell.git synced 2025-01-23 06:08:36 +01:00
Code Issues Packages Projects Releases Wiki Activity

Changed to comment-based help

Browse Source
This commit is contained in:
Markus Fleschutz 2020-12-29 11:27:34 +00:00
parent 793c316d1f
commit 3b83d94809
2 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -141,7 +141,7 @@ Each PowerShell script should follow the 8 golden rules:
* **Rule #1:** the filename should be named `<verb>-<object>.ps1`
* **Rule #2:** the first line reads `#!/snap/bin/powershell` to support PowerShell on Linux
* **Rule #3:** the script has execute file permissions (chmod a+rx <file>) to support PowerShell on Linux
* **Rule #4:** provide a metadata header with syntax, description, author, source, and license
* **Rule #4:** provide a comment-based help with syntax, description, link, author, and license
* **Rule #5:** prefer command-line options, else ask the user
* **Rule #6:** the encoding of the script is in UTF-8 with BOM to support Unicode characters
* **Rule #7:** use `Set-StrictMode -Version Latest` to enable additional error checking

2
Scripts/download.ps1
View File

@ -1,7 +1,7 @@
#!/snap/bin/powershell
<#
.SYNTAX ./download.ps1 [<URL>]
.SYNOPSIS downloads the file/directory from the given URL
.DESCRIPTION downloads the file/directory from the given URL
.LINK https://github.com/fleschutz/PowerShell
.NOTES Author: Markus Fleschutz / License: CC0
#>