Table of Contents

Coding Syntax

Very similar to C++ STL standard, with exception for the compound variables and properties. The uppercasing of compound variables and props make it easier to see and separate between variables and functions.

These rules apply to HTML and CSS too, but with dash instead of low-dash.

// Path, namespace, table
// Lowercase, similar to URL
my_namespace

// Class
// Lowercase, generic nouns
my_class

// Method
// Lowercase, verbs in text
my_method

// Primitive properties
// Lowercase, maths single value
my_primitive

// Compound properties
// Camelcase, maths compound value
My_Compound

// Constant
// Uppercase, similar to digit block letters.
MY_CONSTANT

Lines

• Indentation: 4 spaces (not tabs)
• Margin: 80 chars
• Max line length: 120 chars
• Max lines per func: 100 lines
• Max funcs per file: 100 funcs

Comments

• Always comment after a few lines, code without comments is disaster.

Alignment

• Try to align vertically, easy to see code, quick edit with multi-carets.

Colouring

Suggested colouring

• Colours
  • Red — Method names, action, heat
  • Orange — Literal values, valueable
  • Green — Prop and var names, changeable
  • Cyan — Class names, half-fundamental/half-changeable
  • Blue — Keywords, fundamental, water
  • Purple — Symbols, special
• Grey-scale
  • White — Background, paper
  • Grey — Comments, not highlighted
  • Black — Others, basic foreground colour