Coding Rules

We apply the Sun Code Conventions for the Java Programming language. However, we're only picky about some of them: documentation.

Please document what your classes are supposed to achieve, what your methods are supposed to achieve, what you think their parameters mean, whether parameters and return may be null, and so on.

The Standard Project Template uses CheckStyle to check for the following documentation criteria. If CheckStyle complains, the build provess refuses to create a submission Jar.

• Every class has Javadoc
• Every method has Javadoc
• Every member variable has Javadoc