Writing Rules

/!\ this is a first draft
Back

We'll try to write "clean" code. It was not the case at the beginning, but things change.

So here are some hints :

• all the code should be written in python, except for certain parts like the gui

• this will be modular and object-oriented code to give the maximal flexibility to reuse each component

• everything has to be documented. Sometimes the explanations of complicated algorithms need enough space inside the code, no problem, write as long as required. On another hand, all classes, functions etc. have to be commented for Doxygen, as soon as they are created