Make scripts easier to read and understand

Again… I am NOT a programmer these comments are just my own observations and odd ends I figured out.


Description
Write a description of what the script does generally and list things like what click count and sustain do.
I have script ideas that go on the back burner for months, when I get back to them I can easily figure out what the hell I was thinking at the time.
Also helpful if you want to cannibalise script to morph into something else.

Code:

---

!name ?????
#!autoload
############################################
### Single click = Track1/Loop1 then Play
### Double click = Track1/Loop1 then Overdub
### Long press = Shuufles through Loops A,B,C,
### while clearing loop then overdubing then returns to loop A with overdub off
### GlynnDub - Nov 2011
############################################

---

------------------------------------------------------------------------------------------------------------------



Use ###### to make scripts easier to read
It might look a bit dicky but it breaks the script up into section so it's easer to read.
I think of it like chapters and paragraphs in a book.

Code:

---

!name Omni Toggle A-B
#!autoload
###############################################
###############################################
### This script will toggle all tracks in
### loop 1 to loop 2 and keep going back and
### forth until script is run a 2nd time.
###
### Note... you can modify this script to toggle
### between any two loops see the "???" below
### Glynndub realised 01-06-2015
###############################################
message  Toggle A-D
###############################################
Variable saveTrack track
Track 1
next
###############################################
Variable global inMode false

if inMode
  set inMode false
else
  set inMode true
  while inMode
    wait loop
###############################################
      for *
        if LoopNumber == 2
wait last
message Loop A
          loop 1  # ??? Change loop number here
        else
wait last
message Loop B
          loop 2  # ??? Change loop number here
        endif
      next
  next
###############################################
Track saveTrack
endif
###############################################
next
set quantize Loop
set switchquantize Loop

END END END END END END END END END END END END END END END
END END END END END END END END END END END END END END END

---

Make scripts easier to read and understand