Wiki¶

The goal of this section is to collect guidelines and best practices on writing source code. Common writing rules ensure a better comprension of the code for all team members, and an easy maintaining of the programs. The writing code concerns the following fronts:

1. Executive code;
2. Comments of code;
3. Environment setting;

Executive Code¶

Guideline tutorials:

• Writing Convention

Comments of Code¶

The comments are very important in any source code beacause they improve the readability of the code and the maintenance activity. The DoxyGen is a software which create autmatically the documentation from code comments. Instructions to write comments Doxygen-compatible and the IASFBO used templates are given in:

• DoxyGen Doc

• OLD Template

• AB Template

Environment setting¶

In order to optimize the code writing, each project should define and provide a method that imports correctly the project environment (variables and paths.