Convention de code

Eléments de base à considérer

Avantages de l'usage d'une norme pour écrire du code:

  • Un code bien formaté permet une meilleure lecture
  • Un code qui utilise les mêmes normes est plus facilement maintenable par différents développeurs
  • Un developpeur ne doit pas perdre de temps pour formater son code
  • Tout ce qui est automatisable doit être automatisé

Cela conduit à l'application des règles suivantes:

  • Tout le code source doit utiliser une même norme
  • On utilise les outils de mise en forme automatique pour faciliter le travail du developpeur
  • Quelques règles s'ajoutent pour compléter la mise en forme du code

Formattage automatique

L'outil utilisé pour le developpement étant eclipse, on fournit un fichier de configuration pour le "code formater" d'eclipse. On utilise ensuite le formattage automatique. En principe aucune mise en forme ne doit se faire de manière non automatique. Si le résultat n'est pas optimal, il s'agit souvent de changer le contenu pour obtenir un meilleur formatage.

La version utilisée est: eclipse-code-formater-0.5.xml

Autres règles

On complète ces règles de formatage automatique:

  • Les paramètres d'une méthode commencent par "a_" (*)
  • Les variables locales commencent par "l_" (*)
  • Les variables d'exception sont généralement notées "ex" (*)
  • Les variables de retour sont généralement notées "retour"
  • Les variables de taille de liste sont généralement notées "len"

Les options notées par (*) sont configurables dans eclipse sous la section "java / java style".

Exemple

Voir un exemple de code formaté selon les normes utilisées dans ce projet:TemplateCode