Class code sections

To improve the readability of classes we have decided to divide their code into logical sections. Each section has a relevant comment block on top of it.

The used comment pattern for each section is as follows:

//------------------------ SECTION_NAME --------------------------

Names of all distinguished code sections in SAOS along with their descriptions:

• CONSTRUCTORS - class constructors
• GETTERS - Java Beans getters
• TESTS - test methods in test classes
• LOGIC - public methods of a class that implement its intended functionalities, e.g. Parser.parse(String) or Math.divide(), Court.addDivision(Division).
• PRIVATE - class and package private methods
• SETTERS - Java Beans setters
• HashCode & Equals - hashCode and equals methods
• toString - toString method
• INNER CLASSES - inner classes

The order of the sections in a class should be the same as on the list above.