This is a template PowerShell script that you can use.
The synopsis should be integrated completely for commandline help and if this is not sufficient your should also provide a README.md.
<#
.SYNOPSIS
This is a template for a PowerShell script. It must be used for all new PowerShell scripts that are created.
A brief description of the Get-Something function.
.DESCRIPTION
A detailed description of the Get-Something function.
.PARAMETER ParameterA
The description of the ParameterA parameter.
.PARAMETER ParameterB
The description of the ParameterB parameter.
.EXAMPLE
PS C:\> Get-Something -ParameterA 'One value' -ParameterB 32
'This is the output'
This example shows how to call the Get-Something function with named parameters.
.EXAMPLE
PS C:\> Get-Something 'One value' 32
'This is the output'
This example shows how to call the Get-Something function with positional parameters.
.INPUTS
System.String,System.Int32
.OUTPUTS
System.String
.NOTES
For more information about advanced functions, call Get-Help with any
of the topics in the links listed below.
File Name : template_script.ps1
Author : XOAP - info@xoap.io
Requires : PowerShell V2 (please change as needed)
.LINK
about_modules
.LINK
about_functions_advanced
.LINK
about_comment_based_help
.LINK
about_functions_advanced_parameters
.LINK
about_functions_advanced_methods
#>
#Requires -Version 2.0
#Requires -RunAsAdministrator