How to comment

Please make sure that our code is commented as good as possible. That is necessary for a good quality of code and required for a merge request.

• Class Javadoc: containing the author and the purpose of the class. If not required, further implementation notes are desired.
• Method Javadoc: containing a description of the method itself, of its parameters as well as return values.
• Class Attributes: describe their job

I know this is a lot of extra work, but it will help us five to work together especially if the project code base grows a lot.