Conventions - Ga-3tan/AMT_Project Wiki

Language

This repository and its code are written in English only.

Naming convention

We use Java best naming convention practices.

Code format

Since all the members of the development team use intellij, we decided to use the default formatting of the IDE. This allows us not to have to worry too much about formatting our code while we are writing, but it does require us to do the CTRL+ALT+L shortcut before a push.

Documentation

For documentation we use the Javadoc style at the head of classes and sometimes at methods (only when it is considered necessary).