Skip to content
This repository has been archived by the owner on Dec 8, 2022. It is now read-only.

Coding Conventions

paddatrapper edited this page Sep 20, 2014 · 1 revision

To help make code more readable, understandable, and consistent, each contributor should follow the set guidelines lain out below. If you disagree with something or come across a style that has not been decided upon, make an issue or a pull request respectively for discussion on the best style. The standard will be decided based on either majority rule or official documentation (i.e. oracle coding standard).

  1. Spaces not tabs
  2. Space width is 4
  3. No beginning/trailing empty lines
  4. Each file should start with an import statement if necessary single-spaced
  5. After class declaration and between class methods, there should be a space.
  6. Within methods, there should be no spaces unless to separate specific chuncks of code (i.e not for if statements, return values, or loops)
  7. Opening curly braces appear a space after the closing parentheses, not directly after.
  8. Closing curly braces appear on own line unless followed by an else etc. which will be a space after the curly brace.
  9. Comments should have one space after "//"
  10. Comments 4 or greater in length should be multi-line commented
Clone this wiki locally