magritton
4/29/2020 - 12:53 PM

Powershell Script Header

This is an example of a script comment header to describe and document a Powershell Script

SCriptHeader.ps1
content_copyfile_download
<# 
.SYNOPSIS 
 
 
.DESCRIPTION 
 
 
.NOTES 
┌─────────────────────────────────────────────────────────────────────────────────────────────┐ 
│ ORIGIN STORY                                                                                │ 
├─────────────────────────────────────────────────────────────────────────────────────────────┤ 
│   DATE        : yyyy.mm.dd 
│   AUTHOR      : __AUTHOR_NAME__ 
│   DESCRIPTION : Initial Draft 
└─────────────────────────────────────────────────────────────────────────────────────────────┘ 
 
.PARAMETER Param01 
__DESC_PARAM01__ 
 
.PARAMETER Param02 
__DESC_PARAM02__ 
 
.EXAMPLE 
 
foo ` 
  -Param01 'Hello' ` 
  -Param02 'World' | oh 
 
#>
PSCriptHeader2.ps1
content_copyfile_download
#
.SYNOPSIS
  <Overview of script>
.DESCRIPTION
  <Brief description of script>
.PARAMETER <Parameter_Name>
    <Brief description of parameter input required. Repeat this attribute if required>
.INPUTS
  <Inputs if any, otherwise state None>
.OUTPUTS
  <Outputs if any, otherwise state None - example: Log file stored in C:\Windows\Temp\<name>.log>
.NOTES
  Version:        1.0
  Author:         <Name>
  Creation Date:  <Date>
  Purpose/Change: Initial script development
  
.EXAMPLE
  <Example goes here. Repeat this attribute for more than one example>
#>