STYLEGUIDE

   1 Pineapple Tracker Coding Style
   2 ------------------------------
   3
   4 We try to maintain a consistant style for readability. If you are coding
   5 for pineapple tracker, generally try to follow what you see. Below are
   6 some more specific guidelines.
   7
   8 Functions:
   9 ----------
  10 Put opening curly-bracket on the same line, and no space between the closing
  11 paren and the opening curly bracket.
  12
  13 static int void freqkey(int x, int y, int j){
  14
  15 }
  16
  17 No space between the closing paren and the curly bracket either. If there are
  18 multiple arguements to a function, put one space after the comma, but not
  19 before.
  20
  21 Document your functions! Put a coment above it that looks like this:
  22  //\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\/\\
  23 \\\  < void drawsonged(int,int,int) >                                        .|
  24 ///  Draws the song editor.                                                  .\
  25  \\/\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\//
  26
  27
  28
  29 ~=~~=~=~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~=
  30 STYLEGUIDE TODO:
  31 * wriite something about how to name functions.