Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

No Format
#
# ===================================================================
# Purpose:              Describe the purpose of the script [short version]
# Parameters:           one ; two ; three
#                       ---------------------------
#                       $one = (enum) load, unload
#                       $two = (string) second parameter
#                       $three = (num) expected
#                       ---------------------------
# Called From:          (script) any
# Author:               Matt Petrowsky
# History:Notes:             Additional information [long version]
# Revsion:           Last change: 10/10/10 by MP :: A single comment step with multiple lines
# Notes:                Additional information [long version]
# ===================================================================
#

The History Revision field within the comment is one single script step which contains the latest change date and a date or date/timestamp line for each change documented. Within the comment step it looks like the following.

No Format
   HistoryRevision:

Last change: 10/10/10 by MP
::
10/9/10 - MP - each line of history is within this one comment step
10/10/10 - MP - added the history field to the comments

...

Info
titleShortcuts for inserting date/time values

Using a string expansion program for inserting dates and times into your comments is very helpful. For example, typing dts can be expanded to the current Date time short equivalent. The following are popular packages.
(Mac)TextExpander
@todo:add more itemsFind a list of these tools in Keyword expansion tools in Developer Tools

Custom function commenting

Custom functions should use, at minimum, the following header. Because the header of a custom function is multiple lines of text within the calculation dialog box, you can use spaces for indenting, instead of the proposed tabs. This makes the calculation header easier to read. Tip: many editors have a convert spaces to tabs and inverse functionality.

No Format
/**
 * ==================================================================
 * CustomFunction ( parameter1 ; parameter2 )
 *
 * PARAMETERS:
 *                @parameter1 (text) Input string
 *                @parameter2 (num) Numerical value
 * RETURNS:
 *                (bool) True or False based on proper
 *                evaluation
 * DEPENDENCIES:
 *                none
 * NOTESPURPOSE:
 *            Use this function in Tryorder to always use the List() function whenaccomplish
 *            most wonderful   passing multiple values into var.eval! *things possible!
 * NOTES:
 *                $checkScriptName is a reserved localnone
 *                variable used when you wish to enforce *REVISIONS:
 *            10/23/10 -   that inbound parameters match the name ofInitial release
 *            10/27/10 - Modified to the script. It is reset after the *fix issue
 *            10/31/10 - No returning evaluation.
 * RELEASE:       100917Boolean result
 * ==================================================================
 *
 */

...