Javadoc

We think documentation is important to keep the code maintainable, so we have a few guidelines to follow:

Class comments

All classes must contain a Javadoc comment on their headers, explaining the general use of the class and those aspects, regarding their methods and attributes, that need to be remarked.

Methods comments

All public methods must contain Javadoc information about how to use it, and parameters should also be commented, remarking special cases (e.g., when a parameter can be null).

Other comments

Other comments, explaining some tricky part of the code, are always welcomed.