PowerShell script template

The template below can be used as a starting point for new PowerShell scripts. The template starts with some standard comment-based Help tags that allow the Script to interact with Get-Help and then has sections for Declarations, Functions and the main body of the script.

  Name: script.ps1
  The purpose of this script is to blah blah... What?
  A slightly longer description of example.ps1 Why and How?

.PARAMETER InitialDirectory
  The initial directory which this example script will use.
  A switch parameter that will cause the example function to ADD content.

Add or remove PARAMETERs as required.

    Updated: 2017-01-01        Change comment.
    Release Date: 2017-01-01
  Author: YourName

  Run the Get-Example script to create the c:\example folder:
  Get-Example -Directory c:\example

  Run the Get-Example script to create the folder c:\example and
  overwrite any existing folder in that location:
  Get-Example -Directory c:\example -force

See Help about_Comment_Based_Help for more .Keywords

# Comment-based Help tags were introduced in PS 2.0
#requires -version 2


    [string]$InitialDirectory = $(throw "-InitialDirectory is required."),
    [switch]$Add = $false
#----------------[ Declarations ]------------------------------------------------------

# Set Error Action
# $ErrorActionPreference = "Continue"

# Dot Source any required Function Libraries
# . "C:\Scripts\Functions.ps1"

# Set any initial values
# $Examplefile = "C:\scripts\example.txt"

#----------------[ Functions ]---------------------------------------------------------
Function MyExampleFunction{
    Write-Host "Start example function..."
      "Do Something here"
      "Something went wrong."

    If($?){ # only execute if the function was successful.
      Write-Host "Completed example function."

#----------------[ Main Execution ]----------------------------------------------------

# Script Execution goes here

#Yeah, I'm gonna run to you, cause when the feelin's right I'm gonna stay all night, I'm gonna run to you# ~ Bryan Adams

Related PowerShell Commands:

Run a script - How to run a PowerShell script.
Functions - Write a named block of code

Copyright © SS64.com 1999-2019
Some rights reserved