Skip to content
bgianfo edited this page Dec 30, 2010 · 2 revisions

Some General Style Guide Rules

  1. Spaces or Tabs

    • Spaces should be used instead of tabs for code indention
    • The tabwidth of a indented block should be four spaces.
  2. Brace Style

    • Braces should always be placed on the line immediately after the function or control flow statement.
    • Braces will always be used with a control flow statement, no brace-less if's for's etc...
  3. Function definition

    • All functions should have a space between the previous declaration
    • All functions should have atleast a short doxygen style comment immedietly preceding it's implementation detailing it's input's/output's and possible side effects.
  4. Comments

    • All comments should have a space before the comment text starts
    • All comments should begin with a capital letter
Clone this wiki locally