Code conventions - paffman/WBS-Project GitHub Wiki

The code conventions we're using are Sun's code conventions and Google's java code style document. To enforce these conventions this project is using checkstyle integrated with gradle to warn a developer about code style errors.

Some things checkstyle doesn't test for:

  • Write useful javadocs (in english)
  • All variable, class and method names need to be in english language and self explanatory
  • Avoid confusing if/switch statements
  • Encode your files UTF-8 (seriously, do this!)
  • All classes must be in the package de.fhbingen.wbs