Coding Standards

In order to ease maintenance and provide some consistency to the many source files of this project, some general coding standards are defined.

All contributors are expected to follow these guidelines when working on this project:

  1. Use spaces, not tabs. Make sure your editor inserts 4 spaces as the standard nested indentation.
  2. Provide a Javadoc comment on every class to give an idea of what it is for, even if just a few words.
  3. Use the @author tag on any new classes or functions you create, so we know who to bug when there is a question.
  4. When modifying existing code written by someone else, please avoid any major reformatting. This causes many problems.
  5. Look at existing code in the project as an example for formatting new code.

This list will likely be expanded.

Happy coding!

Last modified 6 years ago Last modified on Jan 11, 2013, 8:52:29 PM