Permalink
Switch branches/tags
Nothing to show
Find file
Fetching contributors…
Cannot retrieve contributors at this time
32 lines (22 sloc) 1.1 KB
Pineapple Tracker Coding Style
------------------------------
We try to maintain a consistent style for readability. If you are coding
for pineapple tracker, generally try to follow what you see. Below are
some more specific guidelines.
Functions:
----------
Put opening curly-bracket on the same line, and no space between the closing
paren and the opening curly bracket.
static int void freqkey(int x, int y, int j){
}
No space between the closing paren and the curly bracket either. If there are
multiple arguements to a function, put one space after the comma, but not
before.
Document your functions! Put a coment above it that looks like this:
//\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\/\\
\\\ < void drawsonged(int,int,int) > .|
/// Draws the song editor. .\
\\/\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\//
~=~~=~=~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~~=~=
STYLEGUIDE TODO:
* write something about how to name functions.