d2.02.01 Programming rules

Summary:

This document presents the rules used by the Aster Development Team (EDA) for writing Code_Aster source code.

Compliance with these rules has two main objectives:

• ensure good code portability,

• ensure good readability (and therefore maintainability) of the source text.

The control of compliance with the programming rules is carried out during the submission of developments (when executing the HG commit and HG submit commands) by the aslint tool (from the devtools repository which can also be used standalone).

The errors (messages of type E or C like error or*convention*) issued by aslint must be corrected by the developer.

Alarms (W-type messages like warning) should be suppressed as much as possible to improve the code and should only be accepted if it is not possible to do otherwise.

This document provides additional elements to the warning messages issued by aslint to explain their purpose.

It also describes conventions or tips that cannot be checked automatically.

• 1. Automatic checks
• 2. Additional rules
  • 2.1. Fortran modules
  • 2.2. Constants
• 3. Bypass the law