Development Style Guide

This page contains the current Style guide for the multiple languages used on TM 4.0

Jade

• use spaces instead of tabs
• use two spaces for tabbing (instead of 4)
• all content should be on markdown pages
• use mixins as much as possible

Coffee-Script

• Set parameter defaults without spaces around the equal sign
  • clear = (count=1) -> instead of clear = (count = 1) ->
• Use parentheses if it improves code clarity.
• Prefer alphabetic keywords to symbolic keywords:
  • a is b instead of a == b
  • a isnt b instead of a != b
• Avoid spaces inside the curly-braces of hash literals:
  • {a: 1, b: 2} instead of { a: 1, b: 2 }
• Include a single line of whitespace between methods.
• Capitalize initialisms and acronyms in names, except for the first word, which should be lower-case:
  • getURI instead of getUri
  • uriToOpen instead of URIToOpen