d2.02.01 Règles de programmation#
Résumé :
Ce document présente les règles retenues par l’équipe de Développement d’Aster (EDA) pour l’écriture du code source de Code_Aster.
Le respect de ces règles a deux objectifs principaux :
assurer une bonne portabilité du code,
assurer une bonne lisibilité (et donc maintenabilité) du texte source.
Le contrôle du respect des règles de programmation est effectué lors de la soumission des développements (lors de l’exécution des commandes hg commit et hg submit) par l’outil aslint (du dépôt devtools qui peut aussi être utilisé de manière autonome).
Les erreurs (messages de type E ou C comme erreur ou convention ) émises par aslint doivent impérativement être corrigées par le développeur.
Les alarmes (messages de type W comme warning ) doivent être supprimées autant que possible pour l’amélioration du code et ne doivent être acceptées uniquement s’il n’est pas possible de faire autrement.
Ce document fournit des éléments complémentaires aux messages de type warning émis par aslint pour en expliquer l’objectif.
On y décrit aussi des conventions ou conseils qui ne peuvent pas être vérifiés automatiquement.