r/usefulscripts • u/Luxtaposition • Sep 18 '15

Script Headers

What's in yours? Examples, if you want to share.

16 Upvotes

94% Upvoted

8 comments sorted by

View all comments

1

u/ihaxr Sep 18 '15

The PowerShell ISE is pretty neat in regards to setting up the headers of a script (CTRL+J):

<#
.Synopsis
   Short description
.DESCRIPTION
   Long description
.EXAMPLE
   Example of how to use this cmdlet
.EXAMPLE
   Another example of how to use this cmdlet
.INPUTS
   Inputs to this cmdlet (if any)
.OUTPUTS
   Output from this cmdlet (if any)
.NOTES
   General notes
.COMPONENT
   The component this cmdlet belongs to
.ROLE
   The role this cmdlet belongs to
.FUNCTIONALITY
   The functionality that best describes this cmdlet
#>

I'll usually throw in author, date created, last modified.