Trying to settle on a script documentation header

I want to add a header to all my scripts, keep things organized
This seemed like a good place to start.

VBSCRIPT:

'  FILENAME:
'  AUTHOR:
'  SYMMARY: A summary of what this script does
'  DESCRIPTION: A more in depth description of the script
'  NOTES:
'
'
'  LINKS:
'  EXAMPLE: document a way of calling the script, plus expected output
'  EXAMPLE: example calling the script differently
'  EXAMPLE: rinse and repeat as needed
'  INPUTS: \\servername,yes,log (example)
'  RETURNVALUE: output type
'  ChangeLog:
'  	YYYY-MM-DD: username-changes made

What do you use? Am I missing something?

Comments are closed.