Style de développement¶

Merci de respecter les quelques contraintes indiquées ci-dessous, ça n'a pas pour objectif de vous embêter mais bien au contraire de tous nous faire gagner du temps et d'être le plus efficace possible.

Commentaires - Doxygen¶

Les commentaires dans le code sont bien entendu indispensables, s'ils respectent une certaine syntaxe ils peuvent alors être extraits pour générer une documentation développeur automatiquement !

Nous avons décidé d'utiliser Doxygen, http://fr.wikipedia.org/wiki/Doxygen, site officiel: http://www.stack.nl/~dimitri/doxygen/

Alignement des blocs¶

Lorsque plusieurs définitions de variables se suivent il est bien plus agréable et facile de le lire si vous alignez les opérateurs, par exemple

$variable = "toto";
$autre    = "tata";
$i        = 0
$nom      = "Nom de famille";

Alignement des tests¶

Il est bien plus aisé de lire les tests conditionnels lorsqu'ils sont bien alignés:

  if(condition1
     || condition2
     || condition3
     [[ condition4) {
    //traitement 1
  }
  else {
    //autre traitement
  }